Skip to content

fix issues 156, 176 - #179

Merged
nsaulnier-ti merged 3 commits into
mainfrom
a0226750_fix_issue156
Oct 29, 2026
Merged

nsaulnier-ti merged 3 commits into
mainfrom
a0226750_fix_issue156

Conversation

@nsaulnier-ti

@nsaulnier-ti nsaulnier-ti commented Oct 8, 2026 •

Copy link
Copy Markdown
Collaborator

Add pointers to docs_ai/README.md:
TRMs & register docs
release_notes
makefile build instructions
Fixes #156 and #176

@qodo-code-review

Copy link
Copy Markdown

PR Summary by Qodo

Fix cross-shell make help and expand AI documentation pointers

🐞 Bug fix 📝 Documentation 🕐 10-20 Minutes

Grey Divider

AI Description

• Quote make help output so it renders correctly under both bash and dash.
• Direct AI agents to build instructions, release notes, and device-specific TRM and register
 references.
Diagram

graph TD
  A["AI agent"] --> B["Documentation index"] --> C["Make help"] --> D["Build guidance"]
  B --> E["Release notes"]
  B --> F["Device references"]
Loading
High-Level Assessment

Keep the root makefile as the authoritative build guide and link to it from the AI documentation rather than duplicating build instructions. Quoting the existing help text addresses shell parsing without changing build behavior.

Files changed (2) +81 / -51

Bug fix (1) +51 / -51
makefileMake help text portable across bash and dash +51/-51

Make help text portable across bash and dash

• Quotes help-message arguments so punctuation and shell metacharacters render as text under bash and dash. Presents the CCS Windows path with forward slashes; build targets themselves are unchanged.

makefile

Documentation (1) +30 / -0
README.mdPoint agents to build, release, and device references +30/-0

Point agents to build, release, and device references

• Adds instructions to consult root-level make help and release notes when relevant. Lists TRM and register references for five device-family entries and advises reading only the needed PDF sections.

docs_ai/README.md

@pratheesh pratheesh left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for this, the make help fix is a nice catch. I checked the help recipe under both bash and dash: before the change the output differs (the **** lines glob-expand and the C:\ti\... path loses its backslashes); after the change both shells print identical, correct text. The new docs_ai/README.md pointers to docs/release_notes.md and make help look good and cover #176. (I could not run a real gmake here, so I tested the recipe lines directly in the shells.)

A couple of small asks:

  • The PR says it fixes #156, but that issue asks for a docs/ page that people (not only AI agents) can find from README.md / getting_started.md, plus a note that these parts have no SPRUHF8A-style standalone guide and a pointer to SPRUIJ2. Could you either link the TRM/register table from README.md or docs/getting_started.md, or change the description to "part of #156"?
  • Please double-check the literature numbers and the "200+ pages" statement against ti.com, since I couldn't verify all of them (I only confirmed AM263x/SPRUJ42 against the issue text).

Otherwise LGTM.

@nsaulnier-ti

Copy link
Copy Markdown
Collaborator Author

@pratheesh thanks for the catch, added a pointer from the top-level readme

@nsaulnier-ti
nsaulnier-ti force-pushed the a0226750_fix_issue156 branch from fb3945f to 6768c70 Compare October 26, 2026 18:15
The makefile echos under 'make/gmake help' worked fine when bash was used,
but broke when dash was used on Ubuntu instead. Use quotation marks so that
the echos render properly in both scenarios.

The Windows path forward slashes were interacting poorly with dash, so I
updated them to backslashes for compatibility reasons.

Signed-off-by: Nick Saulnier <nsaulnier@ti.com>
Signed-off-by: Nick Saulnier <nsaulnier@ti.com>
Signed-off-by: Nick Saulnier <nsaulnier@ti.com>
@nsaulnier-ti
nsaulnier-ti merged commit 58cbf1a into main Oct 29, 2026
7 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.

docs: add a PRU-ICSS documentation map (per-device TRM / register addendum / instruction guide pointers)

4 participants