Skip to content

style: normalize Android RST indentation#720

Merged
StaticRocket merged 1 commit into
TexasInstruments:masterfrom
juliosuas:js/normalize-android-rst-indentation
Jun 24, 2026
Merged

style: normalize Android RST indentation#720
StaticRocket merged 1 commit into
TexasInstruments:masterfrom
juliosuas:js/normalize-android-rst-indentation

Conversation

@juliosuas

Copy link
Copy Markdown
Contributor

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 thread source/android/Overview_Flashing.rst
@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
Contributor 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
Contributor 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

Comment thread source/android/Overview_Flashing.rst Outdated
@StaticRocket

Copy link
Copy Markdown
Member

Could you squash those two commits since you introduced the vale enable/disable lines?

@juliosuas juliosuas force-pushed the js/normalize-android-rst-indentation branch from 2745847 to 0e24d0d Compare June 11, 2026 17:38
Signed-off-by: Julio César Suástegui <juliosuas@users.noreply.github.com>
@juliosuas

Copy link
Copy Markdown
Contributor Author

Thanks, addressed. The branch is now squashed to a single commit and the vale off/on directives are no longer present in source/android/Overview_Flashing.rst.

Local validation:

  • git diff --check origin/master...HEAD
  • bin/delta.sh -a origin/master -b HEAD -- rstcheck -r source/ reports 0 new warnings
  • bin/delta.sh -a origin/master -b HEAD -- ./bin/check_toc_txt.py reports 0 new warnings

@juliosuas juliosuas force-pushed the js/normalize-android-rst-indentation branch from 0e24d0d to 09127d6 Compare June 11, 2026 17:51
Comment thread source/android/Overview_Flashing.rst
@StaticRocket

Copy link
Copy Markdown
Member

Comment thread source/android/Overview_Flashing.rst
Comment thread source/android/Overview_Flashing.rst
@praneethbajjuri praneethbajjuri self-requested a review June 24, 2026 02:09
@StaticRocket StaticRocket merged commit 1869b12 into TexasInstruments:master Jun 24, 2026
6 checks passed
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.

6 participants