doc(linux): Sync AM57 SDK doc form forked repo by uditkumarti · Pull Request #312 · TexasInstruments/processor-sdk-doc

uditkumarti · 2025-06-09T14:07:50Z

No description provided.

github-actions · 2025-06-09T14:08:57Z

New warnings found with rstcheck:

�[1mRemoteTraceback: �[0m
"""
Traceback �[1m(�[0mmost recent call last�[1m)�[0m:
  File "/usr/lib/python3.12/multiprocessing/pool.py", line �[1m125�[0m, in worker
    result = �[1m(�[0m�[3mTrue�[0m, �[1mfunc�[0m�[1m(�[0m*args, **kwds�[1m)�[0m�[1m)�[0m
                    ^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.12/multiprocessing/pool.py", line �[1m51�[0m, in starmapstar
    return �[1mlist�[0m�[1m(�[0m�[1mitertools.starmap�[0m�[1m(�[0margs�[1m[�[0m�[1m0�[0m�[1m]�[0m, args�[1m[�[0m�[1m1�[0m�[1m]�[0m�[1m)�[0m�[1m)�[0m
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.12/site-packages/rstcheck_core/checker.py", line �[1m69�[0m, in
check_file
    source = �[1m_get_source�[0m�[1m(�[0msource_file�[1m)�[0m
             ^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.12/site-packages/rstcheck_core/checker.py", line �[1m129�[0m, 
in _get_source
    return �[1minput_file.read�[0m�[1m(�[0m�[1m)�[0m
           ^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.12/site-packages/docutils/io.py", line �[1m408�[0m, in read
    data = �[1mself.decode�[0m�[1m(�[0mdata�[1m)�[0m
           ^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.12/site-packages/docutils/io.py", line �[1m162�[0m, in decode
    raise �[1mUnicodeError�[0m�[1m(�[0m
UnicodeError: Unable to decode input data.  Tried the following encodings: 
'utf-8'.
�[1m(�[0mUnicodeDecodeError: 'utf-8' codec can't decode byte �[1m0xa0�[0m in position �[1m537�[0m: 
invalid start byte�[1m)�[0m
"""

�[3mThe above exception was the direct cause of the following exception:�[0m

╭───────────────────── �[1mTraceback �[0m�[1;2m(most recent call last)�[0m ──────────────────────╮
│ �[2m/usr/lib/python3.12/site-packages/rstcheck/�[0m�[1m_cli.py�[0m:137 in cli                │
│                                                                              │
│   �[2m134 �[0m�[2m│   │   │   �[0mcheck_paths=files, rstcheck_config=rstcheck_config, overwr │
│   �[2m135 �[0m�[2m│   │   �[0m)                                                              │
│   �[2m136 �[0m�[2m│   │   �[0mlogger.info("Run main runner instance.")                       │
│ ❱ 137 �[2m│   │   �[0m_runner.check()                                                │
│   �[2m138 �[0m�[2m│   │   �[0mexit_code = _runner.print_result()                             │
│   �[2m139 �[0m�[2m│   �[0m                                                                   │
│   �[2m140 �[0m�[2m│   �[0mexcept FileNotFoundError as exc:                                   │
│                                                                              │
│ ╭───────────────────────────────── locals ─────────────────────────────────╮ │
│ │               _runner = �[1m<�[0m�[1mrstcheck_core.runner.RstcheckMainRunner�[0m object  │ │
│ │                         at 0x7f1cb8c5ec00�[1m>�[0m                               │ │
│ │                config = None                                             │ │
│ │             exit_code = 1                                                │ │
│ │                 files = �[1m[�[0m�[1mPosixPath�[0m�[1m(�[0m'source'�[1m)�[0m�[1m]�[0m                            │ │
│ │     ignore_directives = None                                             │ │
│ │      ignore_languages = None                                             │ │
│ │       ignore_messages = None                                             │ │
│ │          ignore_roles = None                                             │ │
│ │  ignore_substitutions = None                                             │ │
│ │             log_level = 'WARNING'                                        │ │
│ │                logger = �[1m<�[0m�[1mLogger�[0m rstcheck._cli �[1m(�[0mWARNING�[1m)�[0m�[1m>�[0m                 │ │
│ │             recursive = True                                             │ │
│ │          report_level = None                                             │ │
│ │       rstcheck_config = �[1mRstcheckConfig�[0m�[1m(�[0m                                  │ │
│ │                         �[2m│   �[0mreport_level=None,                           │ │
│ │                         �[2m│   �[0mignore_directives=None,                      │ │
│ │                         �[2m│   �[0mignore_roles=None,                           │ │
│ │                         �[2m│   �[0mignore_substitutions=None,                   │ │
│ │                         �[2m│   �[0mignore_languages=None,                       │ │
│ │                         �[2m│   �[0mignore_messages=None,                        │ │
│ │                         �[2m│   �[0mconfig_path=None,                            │ │
│ │                         �[2m│   �[0mrecursive=True,                              │ │
│ │                         �[2m│   �[0mwarn_unknown_settings=None                   │ │
│ │                         �[1m)�[0m                                                │ │
│ │               version = None                                             │ │
│ │ warn_unknown_settings = None                                             │ │
│ ╰──────────────────────────────────────────────────────────────────────────╯ │
│                                                                              │
│ �[2m/usr/lib/python3.12/site-packages/rstcheck_core/�[0m�[1mrunner.py�[0m:226 in check       │
│                                                                              │
│   �[2m223 �[0m�[2m│   │   �[0m"""                                                            │
│   �[2m224 �[0m�[2m│   │   �[0mlogger.info("Run checks for all files.")                       │
│   �[2m225 �[0m�[2m│   │   �[0mresults = (                                                    │
│ ❱ 226 �[2m│   │   │   �[0m�[1;4mself�[0m�[1;4m._run_checks_parallel()�[0m                                │
│   �[2m227 �[0m�[2m│   │   │   �[0mif len(self._files_to_check) > 1                           │
│   �[2m228 �[0m�[2m│   │   │   �[0melse self._run_checks_sync()                               │
│   �[2m229 �[0m�[2m│   │   �[0m)                                                              │
│                                                                              │
│ ╭───────────────────────────────── locals ─────────────────────────────────╮ │
│ │ self = �[1m<�[0m�[1mrstcheck_core.runner.RstcheckMainRunner�[0m object at                │ │
│ │        0x7f1cb8c5ec00�[1m>�[0m                                                   │ │
│ ╰──────────────────────────────────────────────────────────────────────────╯ │
│                                                                              │
│ �[2m/usr/lib/python3.12/site-packages/rstcheck_core/�[0m�[1mrunner.py�[0m:201 in             │
│ _run_checks_parallel                                                         │
│                                                                              │
│   �[2m198 �[0m�[2m│   │   │   �[0mself._pool_size,                                           │
│   �[2m199 �[0m�[2m│   │   �[0m)                                                              │
│   �[2m200 �[0m�[2m│   │   �[0mwith multiprocessing.Pool(self._pool_size) as pool:            │
│ ❱ 201 �[2m│   │   │   �[0mreturn �[1;4mpool.starmap(�[0m                                       │
│   �[2m202 �[0m�[1;2;4m│   │   │   │   �[0m�[1;4mchecker.check_file,�[0m                                    │
│   �[2m203 �[0m�[1;2;4m│   │   │   │   �[0m�[1;4m[(file, �[0m�[1;4mself�[0m�[1;4m.config, �[0m�[1;4mself�[0m�[1;4m.overwrite_config) �[0m�[1;4mfor�[0m�[1;4m file �[0m�[1;4mi�[0m │
│   �[2m204 �[0m�[1;2;4m│   │   │   �[0m�[1;4m)�[0m                                                          │
│                                                                              │
│ ╭───────────────────────────────── locals ─────────────────────────────────╮ │
│ │ pool = �[1m<�[0m�[1mmultiprocessing.pool.Pool�[0m state=TERMINATE pool_size=4�[1m>�[0m           │ │
│ │ self = �[1m<�[0m�[1mrstcheck_core.runner.RstcheckMainRunner�[0m object at                │ │
│ │        0x7f1cb8c5ec00�[1m>�[0m                                                   │ │
│ ╰──────────────────────────────────────────────────────────────────────────╯ │
│                                                                              │
│ �[2m/usr/lib/python3.12/multiprocessing/�[0m�[1mpool.py�[0m:375 in starmap                   │
│                                                                              │
│   �[2m372 �[0m�[2m│   │   �[0mbe iterables as well and will be unpacked as arguments. Hence  │
│   �[2m373 �[0m�[2m│   │   �[0m`func` and (a, b) becomes func(a, b).                          │
│   �[2m374 �[0m�[2m│   │   �[0m'''                                                            │
│ ❱ 375 �[2m│   │   �[0mreturn �[1;4mself�[0m�[1;4m._map_async(func, iterable, starmapstar, chunksize)�[0m │
│   �[2m376 �[0m�[2m│   �[0m                                                                   │
│   �[2m377 �[0m�[2m│   �[0mdef starmap_async(self, func, iterable, chunksize=None, callback=N │
│   �[2m378 �[0m�[2m│   │   │   �[0merror_callback=None):                                      │
│                                                                              │
│ ╭───────────────────────────────── locals ─────────────────────────────────╮ │
│ │ chunksize = None                                                         │ │
│ │  iterable = �[1m[�[0m                                                            │ │
│ │             �[2m│   �[0m�[1m(�[0m                                                        │ │
│ │             �[2m│   │   �[0m                                                     │ │
│ │             �[1mPosixPath�[0m�[1m(�[0m'source/devices/AM335X/linux/Release_Specific_Mig… │ │
│ │             �[2m│   │   �[0m�[1mRstcheckConfig�[0m�[1m(�[0m                                      │ │
│ │             �[2m│   │   │   �[0mreport_level=None,                               │ │
│ │             �[2m│   │   │   �[0mignore_directives=None,                          │ │
│ │             �[2m│   │   │   �[0mignore_roles=None,                               │ │
│ │             �[2m│   │   │   �[0mignore_substitutions=None,                       │ │
│ │             �[2m│   │   │   �[0mignore_languages=None,                           │ │
│ │             �[2m│   │   │   �[0mignore_messages=None,                            │ │
│ │             �[2m│   │   │   �[0mconfig_path=None,                                │ │
│ │             �[2m│   │   │   �[0mrecursive=True,                                  │ │
│ │             �[2m│   │   │   �[0mwarn_unknown_settings=None                       │ │
│ │             �[2m│   │   �[0m�[1m)�[0m,                                                   │ │
│ │             �[2m│   │   �[0mFalse                                                │ │
│ │             �[2m│   �[0m�[1m)�[0m,                                                       │ │
│ │             �[2m│   �[0m�[1m(�[0m                                                        │ │
│ │             �[2m│   │   �[0m�[1mPosixPath�[0m�[1m(�[0m'source/devices/AM335X/linux/index.rst'�[1m)�[0m,  │ │
│ │             �[2m│   │   �[0m�[1mRstcheckConfig�[0m�[1m(�[0m                                      │ │
│ │             �[2m│   │   │   �[0mreport_level=None,                               │ │
│ │             �[2m│   │   │   �[0mignore_directives=None,                          │ │
│ │             �[2m│   │   │   �[0mignore_roles=None,                               │ │
│ │             �[2m│   │   │   �[0mignore_substitutions=None,                       │ │
│ │             �[2m│   │   │   �[0mignore_languages=None,                           │ │
│ │             �[2m│   │   │   �[0mignore_messages=None,                            │ │
│ │             �[2m│   │   │   �[0mconfig_path=None,                                │ │
│ │             �[2m│   │   │   �[0mrecursive=True,                                  │ │
│ │             �[2m│   │   │   �[0mwarn_unknown_settings=None                       │ │
│ │             �[2m│   │   �[0m�[1m)�[0m,                                                   │ │
│ │             �[2m│   │   �[0mFalse                                                │ │
│ │             �[2m│   �[0m�[1m)�[0m,                                                       │ │
│ │             �[2m│   �[0m�[1m(�[0m                                                        │ │
│ │             �[2m│   │   �[0m                                                     │ │
│ │             �[1mPosixPath�[0m�[1m(�[0m'source/devices/AM335X/linux/Release_Specific_Per… │ │
│ │             �[2m│   │   �[0m�[1mRstcheckConfig�[0m�[1m(�[0m                                      │ │
│ │             �[2m│   │   │   �[0mreport_level=None,                               │ │
│ │             �[2m│   │   │   �[0mignore_directives=None,                          │ │
│ │             �[2m│   │   │   �[0mignore_roles=None,                               │ │
│ │             �[2m│   │   │   �[0mignore_substitutions=None,                       │ │
│ │             �[2m│   │   │   �[0mignore_languages=None,                           │ │
│ │             �[2m│   │   │   �[0mignore_messages=None,                            │ │
│ │             �[2m│   │   │   �[0mconfig_path=None,                                │ │
│ │             �[2m│   │   │   �[0mrecursive=True,                                  │ │
│ │             �[2m│   │   │   �[0mwarn_unknown_settings=None                       │ │
│ │             �[2m│   │   �[0m�[1m)�[0m,                                                   │ │
│ │             �[2m│   │   �[0mFalse                                                │ │
│ │             �[2m│   �[0m�[1m)�[0m,                                                       │ │
│ │             �[2m│   �[0m�[1m(�[0m                                                        │ │
│ │             �[2m│   │   �[0m                                                     │ │
│ │             �[1mPosixPath�[0m�[1m(�[0m'source/devices/AM335X/linux/Release_Specific_Rel… │ │
│ │             �[2m│   │   �[0m�[1mRstcheckConfig�[0m�[1m(�[0m                                      │ │
│ │             �[2m│   │   │   �[0mreport_level=None,                               │ │
│ │             �[2m│   │   │   �[0mignore_directives=None,                          │ │
│ │             �[2m│   │   │   �[0mignore_roles=None,                               │ │
│ │             �[2m│   │   │   �[0mignore_substitutions=None,                       │ │
│ │             �[2m│   │   │   �[0mignore_languages=None,                           │ │
│ │             �[2m│   │   │   �[0mignore_messages=None,                            │ │
│ │             �[2m│   │   │   �[0mconfig_path=None,                                │ │
│ │             �[2m│   │   │   �[0mrecursive=True,                                  │ │
│ │             �[2m│   │   │   �[0mwarn_unknown_settings=None                       │ │
│ │             �[2m│   │   �[0m�[1m)�[0m,                                                   │ │
│ │             �[2m│   │   �[0mFalse                                                │ │
│ │             �[2m│   �[0m�[1m)�[0m,                                                       │ │
│ │             �[2m│   �[0m�[1m(�[0m                                                        │ │
│ │             �[2m│   │   �[0m                                                     │ │
│ │             �[1mPosixPath�[0m�[1m(�[0m'source/devices/AM335X/linux/Release_Specific.rst… │ │
│ │             �[2m│   │   �[0m�[1mRstcheckConfig�[0m�[1m(�[0m                                      │ │
│ │             �[2m│   │   │   �[0mreport_level=None,                               │ │
│ │             �[2m│   │   │   �[0mignore_directives=None,                          │ │
│ │             �[2m│   │   │   �[0mignore_roles=None,                               │ │
│ │             �[2m│   │   │   �[0mignore_substitutions=None,                       │ │
│ │             �[2m│   │   │   �[0mignore_languages=None,                           │ │
│ │             �[2m│   │   │   �[0mignore_messages=None,                            │ │
│ │             �[2m│   │   │   �[0mconfig_path=None,                                │ │
│ │             �[2m│   │   │   �[0mrecursive=True,                                  │ │
│ │             �[2m│   │   │   �[0mwarn_unknown_settings=None                       │ │
│ │             �[2m│   │   �[0m�[1m)�[0m,                                                   │ │
│ │             �[2m│   │   �[0mFalse                                                │ │
│ │             �[2m│   �[0m�[1m)�[0m,                                                       │ │
│ │             �[2m│   �[0m�[1m(�[0m                                                        │ │
│ │             �[2m│   │   �[0m�[1mPosixPath�[0m�[1m(�[0m'source/devices/AM57X/linux/index.rst'�[1m)�[0m,   │ │
│ │             �[2m│   │   �[0m�[1mRstcheckConfig�[0m�[1m(�[0m                                      │ │
│ │             �[2m│   │   │   �[0mreport_level=None,                               │ │
│ │             �[2m│   │   │   �[0mignore_directives=None,                          │ │
│ │             �[2m│   │   │   �[0mignore_roles=None,                               │ │
│ │             �[2m│   │   │   �[0mignore_substitutions=None,                       │ │
│ │             �[2m│   │   │   �[0mignore_languages=None,                           │ │
│ │             �[2m│   │   │   �[0mignore_messages=None,                            │ │
│ │             �[2m│   │   │   �[0mconfig_path=None,                                │ │
│ │             �[2m│   │   │   �[0mrecursive=True,                                  │ │
│ │             �[2m│   │   │   �[0mwarn_unknown_settings=None                       │ │
│ │             �[2m│   │   �[0m�[1m)�[0m,                                                   │ │
│ │             �[2m│   │   �[0mFalse                                                │ │
│ │             �[2m│   �[0m�[1m)�[0m,                                                       │ │
│ │             �[2m│   �[0m�[1m(�[0m                                                        │ │
│ │             �[2m│   │   �[0m                                                     │ │
│ │             �[1mPosixPath�[0m�[1m(�[0m'source/devices/AM57X/linux/Release_Specific_Perf… │ │
│ │             �[2m│   │   �[0m�[1mRstcheckConfig�[0m�[1m(�[0m                                      │ │
│ │             �[2m│   │   │   �[0mreport_level=None,                               │ │
│ │             �[2m│   │   │   �[0mignore_directives=None,                          │ │
│ │             �[2m│   │   │   �[0mignore_roles=None,                               │ │
│ │             �[2m│   │   │   �[0mignore_substitutions=None,                       │ │
│ │             �[2m│   │   │   �[0mignore_languages=None,                           │ │
│ │             �[2m│   │   │   �[0mignore_messages=None,                            │ │
│ │             �[2m│   │   │   �[0mconfig_path=None,                                │ │
│ │             �[2m│   │   │   �[0mrecursive=True,                                  │ │
│ │             �[2m│   │   │   �[0mwarn_unknown_settings=None                       │ │
│ │             �[2m│   │   �[0m�[1m)�[0m,                                                   │ │
│ │             �[2m│   │   �[0mFalse                                                │ │
│ │             �[2m│   �[0m�[1m)�[0m,                                                       │ │
│ │             �[2m│   �[0m�[1m(�[0m                                                        │ │
│ │             �[2m│   │   �[0m                                                     │ │
│ │             �[1mPosixPath�[0m�[1m(�[0m'source/devices/AM57X/linux/Release_Specific_Rele… │ │
│ │             �[2m│   │   �[0m�[1mRstcheckConfig�[0m�[1m(�[0m                                      │ │
│ │             �[2m│   │   │   �[0mreport_level=None,                               │ │
│ │             �[2m│   │   │   �[0mignore_directives=None,                          │ │
│ │             �[2m│   │   │   �[0mignore_roles=None,                               │ │
│ │             �[2m│   │   │   �[0mignore_substitutions=None,                       │ │
│ │             �[2m│   │   │   �[0mignore_languages=None,                           │ │
│ │             �[2m│   │   │   �[0mignore_messages=None,                            │ │
│ │             �[2m│   │   │   �[0mconfig_path=None,                                │ │
│ │             �[2m│   │   │   �[0mrecursive=True,                                  │ │
│ │             �[2m│   │   │   �[0mwarn_unknown_settings=None                       │ │
│ │             �[2m│   │   �[0m�[1m)�[0m,                                                   │ │
│ │             �[2m│   │   �[0mFalse                                                │ │
│ │             �[2m│   �[0m�[1m)�[0m,                                                       │ │
│ │             �[2m│   �[0m�[1m(�[0m                                                        │ │
│ │             �[2m│   │   �[0m                                                     │ │
│ │             �[1mPosixPath�[0m�[1m(�[0m'source/devices/AM57X/linux/Release_Specific_Yoct… │ │
│ │             �[2m│   │   �[0m�[1mRstcheckConfig�[0m�[1m(�[0m                                      │ │
│ │             �[2m│   │   │   �[0mreport_level=None,                               │ │
│ │             �[2m│   │   │   �[0mignore_directives=None,                          │ │
│ │             �[2m│   │   │   �[0mignore_roles=None,                               │ │
│ │             �[2m│   │   │   �[0mignore_substitutions=None,                       │ │
│ │             �[2m│   │   │   �[0mignore_languages=None,                           │ │
│ │             �[2m│   │   │   �[0mignore_messages=None,                            │ │
│ │             �[2m│   │   │   �[0mconfig_path=None,                                │ │
│ │             �[2m│   │   │   �[0mrecursive=True,                                  │ │
│ │             �[2m│   │   │   �[0mwarn_unknown_settings=None                       │ │
│ │             �[2m│   │   �[0m�[1m)�[0m,                                                   │ │
│ │             �[2m│   │   �[0mFalse                                                │ │
│ │             �[2m│   �[0m�[1m)�[0m,                                                       │ │
│ │             �[2m│   �[0m�[1m(�[0m                                                        │ │
│ │             �[2m│   │   �[0m                                                     │ │
│ │             �[1mPosixPath�[0m�[1m(�[0m'source/devices/AM57X/linux/Release_Specific.rst'�[1m…�[0m │ │
│ │             �[2m│   │   �[0m�[1mRstcheckConfig�[0m�[1m(�[0m                                      │ │
│ │             �[2m│   │   │   �[0mreport_level=None,                               │ │
│ │             �[2m│   │   │   �[0mignore_directives=None,                          │ │
│ │             �[2m│   │   │   �[0mignore_roles=None,                               │ │
│ │             �[2m│   │   │   �[0mignore_substitutions=None,                       │ │
│ │             �[2m│   │   │   �[0mignore_languages=None,                           │ │
│ │             �[2m│   │   │   �[0mignore_messages=None,                            │ │
│ │             �[2m│   │   │   �[0mconfig_path=None,                                │ │
│ │             �[2m│   │   │   �[0mrecursive=True,                                  │ │
│ │             �[2m│   │   │   �[0mwarn_unknown_settings=None                       │ │
│ │             �[2m│   │   �[0m�[1m)�[0m,                                                   │ │
│ │             �[2m│   │   �[0mFalse                                                │ │
│ │             �[2m│   �[0m�[1m)�[0m,                                                       │ │
│ │             �[2m│   �[0m... +654                                                 │ │
│ │             �[1m]�[0m                                                            │ │
│ │      self = �[1m<�[0m�[1mmultiprocessing.pool.Pool�[0m state=TERMINATE pool_size=4�[1m>�[0m      │ │
│ ╰──────────────────────────────────────────────────────────────────────────╯ │
│                                                                              │
│ �[2m/usr/lib/python3.12/multiprocessing/�[0m�[1mpool.py�[0m:774 in get                       │
│                                                                              │
│   �[2m771 �[0m�[2m│   │   �[0mif self._success:                                              │
│   �[2m772 �[0m�[2m│   │   │   �[0mreturn self._value                                         │
│   �[2m773 �[0m�[2m│   │   �[0melse:                                                          │
│ ❱ 774 �[2m│   │   │   �[0m�[1;4mraise�[0m�[1;4m �[0m�[1;4mself�[0m�[1;4m._value�[0m                                          │
│   �[2m775 �[0m�[2m│   �[0m                                                                   │
│   �[2m776 �[0m�[2m│   �[0mdef _set(self, i, obj):                                            │
│   �[2m777 �[0m�[2m│   │   �[0mself._success, self._value = obj                               │
│                                                                              │
│ ╭────────────────────────────── locals ───────────────────────────────╮      │
│ │    self = �[1m<�[0m�[1mmultiprocessing.pool.MapResult�[0m object at 0x7f1cb948cbf0�[1m>�[0m │      │
│ │ timeout = None                                                      │      │
│ ╰─────────────────────────────────────────────────────────────────────╯      │
╰──────────────────────────────────────────────────────────────────────────────╯
�[1mUnicodeError: �[0mUnable to decode input data.  Tried the following encodings: 
'utf-8'.
�[1m(�[0mUnicodeDecodeError: 'utf-8' codec can't decode byte �[1m0xa0�[0m in position �[1m537�[0m: 
invalid start byte�[1m)�[0m

StaticRocket

I'll continue reviewing this once the encoding and immediate regressions have been resolved.

Where did this fork come from? Why was it even created to begin with? Foundational components were being updated for the AM57 release here, even if the release specific docs weren't being updated.

StaticRocket · 2025-06-09T17:35:58Z

-linux/Foundational_Components/U-Boot/Apps-SPL-Debug-OpenOCD
+linux/Foundational_Components/U-Boot/Apps-SPL-Debug


Direct regression from #272

I don't understand this , OCD is not documented ever for AM57, and this is toc for AM57

It was documented as part of #272. I asked if this was applicable to legacy platforms since it was replacing the Apps-SPL-Debug guide. At the time I was told that the guide was applicable.

@jonaswood01 for more information here.

StaticRocket · 2025-06-09T17:36:44Z

-linux/Foundational_Components/Kernel/Kernel_Drivers/Crypto/SA2UL_OMAP
+linux/Foundational_Components/Kernel/Kernel_Drivers/Crypto


File no longer exists

This PR adds this
new file mode 100644
index 00000000..3eec6f57
--- /dev/null
+++ b/source/linux/Foundational_Components/Kernel/Kernel_Drivers/Crypto.rst

Yes, because it was never removed in that fork. It was removed here. Please discuss why it was removed with the IP owner.

StaticRocket · 2025-06-09T17:38:09Z

-linux/Foundational_Components/Graphics/index
+linux/Foundational_Components_Graphics


StaticRocket · 2025-06-09T17:38:25Z

 linux/Foundational_Components/Kernel/Kernel_Drivers/Storage/NAND
 linux/Foundational_Components/Kernel/Kernel_Drivers/Storage/MMC-SD
 linux/Foundational_Components/Kernel/Kernel_Drivers/UART
-linux/Foundational_Components/Kernel/Kernel_Drivers/UBIFS


why regression, I don't think, we support UBIFS on AM57

StaticRocket · 2025-06-09T17:38:43Z

 linux/Foundational_Components/Graphics/Common/PVR_Tools
 linux/Foundational_Components/Graphics/Common/QT_Graphics_Framework
 linux/Foundational_Components/Graphics/Common/Weston
+linux/Foundational_Components/Graphics/SGX/Migration_From_Prior_Releases


will fix it

StaticRocket · 2025-06-09T17:41:02Z

+::
+


will fix this

StaticRocket · 2025-06-09T17:41:10Z

  <http://software-dl.ti.com/processor-sdk-rtos/esd/docs/latest/
  rtos/index_Foundational_Components.html#ipc>`__

+|


will fix this

StaticRocket · 2025-06-09T17:42:42Z

more details please

StaticRocket · 2025-06-09T17:43:13Z

    :maxdepth: 3

    Apps-TroubleShooting
+    Apps-SPL-Debug


more details please

StaticRocket · 2025-06-09T17:43:19Z

more details please

github-actions · 2025-06-10T14:19:42Z

New warnings found with rstcheck:

source/linux/Release_Specific_Migration_Guide.rst:3: (SEVERE/4) Problems with "include" directive path:
source/linux/Release_Specific_Migration_Guide.rst:8: (SEVERE/4) Problems with "include" directive path:
source/linux/Release_Specific_Migration_Guide.rst:11: (SEVERE/4) Problems with "include" directive path:
source/linux/Overview/Top_Level_Makefile.rst:68: (WARNING/2) Bullet list ends without a blank line; unexpected unindent.
source/linux/Overview/Top_Level_Makefile.rst:74: (WARNING/2) Explicit markup ends without a blank line; unexpected unindent.
source/linux/Foundational_Components/IPC/_Multiple_Ways_of_ARM-DSP_Communication.rst:229: (WARNING/2) Line block ends without a blank line.
source/linux/Foundational_Components/IPC/_IPC_for_K2x.rst:567: (WARNING/2) Literal block expected; none found.
source/linux/Foundational_Components/Graphics/SGX/Migration_From_Prior_Releases.rst:78: (INFO/1) Duplicate implicit target name: "window system libraries".
source/linux/Foundational_Components/Graphics/SGX/Migration_From_Prior_Releases.rst:110: (INFO/1) Duplicate implicit target name: "window system libraries".
source/linux/Foundational_Components/Graphics/SGX/Migration_From_Prior_Releases.rst:157: (INFO/1) Duplicate implicit target name: "window system libraries".

uditkumarti · 2025-06-10T14:21:49Z

will address all comments . soon

uditkumarti · 2025-06-11T02:56:45Z

I'll continue reviewing this once the encoding and immediate regressions have been resolved.

Where did this fork come from? Why was it even created to begin with? Foundational components were being updated for the AM57 release here, even if the release specific docs weren't being updated.

Way back during SDK 9.x , 3PE did this fork

github-actions · 2025-06-11T03:14:17Z

New warnings found with rstcheck:

source/linux/Release_Specific_Migration_Guide.rst:3: (SEVERE/4) Problems with "include" directive path:
source/linux/Release_Specific_Migration_Guide.rst:8: (SEVERE/4) Problems with "include" directive path:
source/linux/Release_Specific_Migration_Guide.rst:11: (SEVERE/4) Problems with "include" directive path:
source/linux/Overview/Top_Level_Makefile.rst:68: (WARNING/2) Bullet list ends without a blank line; unexpected unindent.
source/linux/Overview/Top_Level_Makefile.rst:74: (WARNING/2) Explicit markup ends without a blank line; unexpected unindent.

StaticRocket · 2025-06-11T21:59:14Z

@uditkumarti almost all of the regressions I pointed out were due to changes that occurred in this repository being directly overwritten by this PR.

Unless there were mandatory changes that occurred in the fork that should outweigh what has occurred here I'm counting it as a regression. (And even if those changes are necessary they should follow renames/removals of those files instead of simply adding the old file as is back to the tree.)

uditkumarti requested review from StaticRocket, VeeruPrudhvi, aniket-l, cshilwant and praneethbajjuri as code owners June 9, 2025 14:07

github-actions Bot assigned 3V3RYONE, aniket-l, bryanbrattlof, devarsht, jmenti, praneethbajjuri, r-vignesh, StaticRocket and uditkumarti Jun 9, 2025

StaticRocket requested changes Jun 9, 2025

View reviewed changes

uditkumarti force-pushed the am57_doc_sync branch from d1087eb to 501d301 Compare June 10, 2025 14:18

uditkumarti force-pushed the am57_doc_sync branch from 501d301 to 8142356 Compare June 11, 2025 03:13

github-actions Bot requested review from bryanbrattlof, devarsht, jmenti and r-vignesh June 11, 2025 03:13

uditkumarti closed this Jun 30, 2025

uditkumarti force-pushed the am57_doc_sync branch from 8142356 to 4fe1623 Compare June 30, 2025 10:33

		linux/Foundational_Components/U-Boot/Apps-SPL-Debug-OpenOCD
		linux/Foundational_Components/U-Boot/Apps-SPL-Debug

		linux/Foundational_Components/Kernel/Kernel_Drivers/Crypto/SA2UL_OMAP
		linux/Foundational_Components/Kernel/Kernel_Drivers/Crypto

		linux/Foundational_Components/Graphics/index
		linux/Foundational_Components_Graphics

Conversation

uditkumarti commented Jun 9, 2025

Uh oh!

github-actions Bot commented Jun 9, 2025

Uh oh!

StaticRocket left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Jun 10, 2025

Uh oh!

uditkumarti commented Jun 10, 2025

Uh oh!

uditkumarti commented Jun 11, 2025

Uh oh!

github-actions Bot commented Jun 11, 2025

Uh oh!

StaticRocket commented Jun 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

StaticRocket commented Jun 11, 2025 •

edited

Loading