Skip to content

style: normalize Android RST indentation#720

Open
juliosuas wants to merge 1 commit into
TexasInstruments:masterfrom
juliosuas:js/normalize-android-rst-indentation
Open

style: normalize Android RST indentation#720
juliosuas wants to merge 1 commit into
TexasInstruments:masterfrom
juliosuas:js/normalize-android-rst-indentation

Conversation

@juliosuas

Copy link
Copy Markdown

Summary

  • normalize Android RST indentation to the documented 3-space style
  • adjust nested directives and code blocks in the Android docs listed in Renormalize indentation in android documentation #470
  • include the moved BeagleY-AI Android app note path that replaced the issue's older AM67A path

Partially addresses #470.

Verification

  • git diff --check
  • docker run --rm -v "$PWD":/build -w /build ghcr.io/texasinstruments/processor-sdk-doc:latest rstcheck source/android/Application_Notes_Android_Secure_Build.rst source/android/Application_Notes_Camera.rst source/android/Application_Notes_Sample_Maps_App.rst source/android/Overview_Building_the_SDK.rst source/android/Overview_Flashing.rst source/boards/beagle/BeagleY-AI/android/Application_Notes_BeagleY_AI.rst
    • reports only the existing Overview_Flashing.rst INFO about the enumerated list continuing at step 5 after the command table
  • docker run --rm -v "$PWD":/build -w /build ghcr.io/texasinstruments/processor-sdk-doc:latest make lint
    • currently fails on pre-existing issues outside the files changed here

Comment on lines +393 to +395
#. Once the flashing is complete, power off the board

6. Change boot mode DIP switches to boot from eMMC user partitions and power cycle the board:
#. Change boot mode DIP switches to boot from eMMC user partitions and power cycle the board:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with this change, but you will need to fix the indentation in the previous sections to prevent regression here. Auto-numbering only works if there is nothing at the same indentation level to break the numbered sections:

#. List 1 element 1

   .. code-block::
      hello

#. List 1 element 2

Otherwise it does this:

#. List 1 element 1

.. code-block::
   hello

#. List 2 element 1

@juliosuas juliosuas force-pushed the js/normalize-android-rst-indentation branch 2 times, most recently from 74234c0 to 10474ee Compare June 10, 2026 16:59
@juliosuas

Copy link
Copy Markdown
Author

Thanks for the review. I updated the branch to address the list-continuation issue directly:

  • reduced the PR to the reviewed file only: source/android/Overview_Flashing.rst
  • moved the intervening flashing table/tip/warning content under step 4 so the following #. items remain part of the same numbered sequence
  • kept the final steps auto-numbered after that continuation block
  • checked the updated diff with git diff --check locally

The new head is 10474ee.

@juliosuas juliosuas force-pushed the js/normalize-android-rst-indentation branch from 10474ee to 307c4d4 Compare June 10, 2026 17:05
@juliosuas

Copy link
Copy Markdown
Author

Updated the branch to address the remaining list-structure issue in Overview_Flashing.rst.

What changed:

  • kept the PC/device list-table, tip, and warning nested under step 4 so the following #. steps continue the same numbered sequence
  • fixed the nested code-block indentation under the AM62Px/AM67A ifconfig blocks
  • fixed the mtools command indentation under its code block
  • adjusted changed lines that triggered Red Hat Vale bootloader term errors

Local validation:

  • rstcheck source/android/Overview_Flashing.rst passes
  • git diff --check origin/master...HEAD passes
  • Vale JSON check over the changed lines reports 0 alerts / 0 errors


.. list-table::
:header-rows: 1
.. vale off

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please don't enable/disable vale comments

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants