Skip to content

doc(linux): Sync AM57 SDK doc form forked repo #312

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

doc(linux): Sync AM57 SDK doc form forked repo #312

wants to merge 1 commit into from

Conversation

uditkumarti
Copy link
Collaborator

No description provided.

@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 9, 2025

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
StaticRocket requested changes Jun 9, 2025
View reviewed changes
Copy link
Member

@StaticRocket StaticRocket left a comment

Choose a reason for hiding this comment

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

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.

configs/AM57X/AM57X_linux_toc.txt
Comment on lines -40 to +37
linux/Foundational_Components/U-Boot/Apps-SPL-Debug-OpenOCD
linux/Foundational_Components/U-Boot/Apps-SPL-Debug
Copy link
Member

Choose a reason for hiding this comment

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

Direct regression from #272

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

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

Copy link
Member

Choose a reason for hiding this comment

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

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.

configs/AM57X/AM57X_linux_toc.txt
Comment on lines -50 to +44
linux/Foundational_Components/Kernel/Kernel_Drivers/Crypto/SA2UL_OMAP
linux/Foundational_Components/Kernel/Kernel_Drivers/Crypto
Copy link
Member

Choose a reason for hiding this comment

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

File no longer exists

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

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

Copy link
Member

Choose a reason for hiding this comment

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

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

configs/AM57X/AM57X_linux_toc.txt Outdated
Comment on lines 101 to 90
linux/Foundational_Components/Graphics/index
linux/Foundational_Components_Graphics
Copy link
Member

Choose a reason for hiding this comment

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

Regression

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

will fix

configs/AM57X/AM57X_linux_toc.txt
linux/Foundational_Components/Kernel/Kernel_Drivers/PWM
linux/Foundational_Components/Kernel/Kernel_Drivers/QSPI
linux/Foundational_Components/Kernel/Kernel_Drivers/SPI
linux/Foundational_Components/Kernel/Kernel_Drivers/Storage/SATA
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
Copy link
Member

Choose a reason for hiding this comment

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

Regression

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

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

configs/AM57X/AM57X_linux_toc.txt Outdated
linux/Foundational_Components/Graphics/Common/Display
linux/Foundational_Components/Graphics/Common/GTK+_Graphics_Framework
linux/Foundational_Components/Graphics/Common/OpenGL_ES
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
Copy link
Member

Choose a reason for hiding this comment

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

Regression

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

will fix it

source/linux/Foundational_Components/IPC/_IPC_for_K2x.rst Outdated
Comment on lines 565 to 566
::

Copy link
Member

Choose a reason for hiding this comment

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

Invalid

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

will fix this

source/linux/Foundational_Components/IPC/_Multiple_Ways_of_ARM-DSP_Communication.rst Outdated
@@ -225,6 +225,7 @@ and DSP processors in a multi-processor environment.
<http://software-dl.ti.com/processor-sdk-rtos/esd/docs/latest/
rtos/index_Foundational_Components.html#ipc>`__

|
Copy link
Member

Choose a reason for hiding this comment

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

Invalid

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

will fix this

source/linux/Foundational_Components/Tools/Flash_via_DFU.rst Outdated
Copy link
Member

Choose a reason for hiding this comment

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

Regression

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

more details please

source/linux/Foundational_Components/U-Boot/Applications.rst
@@ -6,6 +6,7 @@ Troubleshooting
:maxdepth: 3

Apps-TroubleShooting
Apps-SPL-Debug
Copy link
Member

Choose a reason for hiding this comment

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

Regression

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

more details please

source/linux/Foundational_Components/U-Boot/Apps-SPL-Debug.rst Outdated
Copy link
Member

Choose a reason for hiding this comment

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

Regression

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

more details please

@github-actions GitHub Actions
Copy link

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
Copy link
Collaborator Author

will address all comments . soon

@uditkumarti
Copy link
Collaborator Author

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

@uditkumarti
doc(linux): Sync AM57 SDK doc form forked repo
8142356 
v2: fixed rst warning

Signed-off-by: Udit Kumar <u-kumar1@ti.com>
@github-actions GitHub Actions
Copy link

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
Copy link
Member

StaticRocket commented Jun 11, 2025 •
edited
Loading

@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.)

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

@StaticRocket StaticRocket

@cshilwant cshilwant

@praneethbajjuri praneethbajjuri

@aniket-l aniket-l

@VeeruPrudhvi VeeruPrudhvi

@bryanbrattlof bryanbrattlof

@devarsht devarsht

@jmenti jmenti

@r-vignesh r-vignesh

Requested changes must be addressed to merge this pull request.

Assignees

@praneethbajjuri praneethbajjuri

@devarsht devarsht

@r-vignesh r-vignesh

@bryanbrattlof bryanbrattlof

@StaticRocket StaticRocket

@3V3RYONE 3V3RYONE

@aniket-l aniket-l

@uditkumarti uditkumarti

@jmenti jmenti

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
9 participants
@uditkumarti @StaticRocket @praneethbajjuri @devarsht @r-vignesh @bryanbrattlof @3V3RYONE @aniket-l @jmenti