docs:opkg: clean up RST #91
Conversation
* Fixup minor RST layout issues. * Use inline literal markup for inline code and applications, rather than bold. * Refer to IPKs and DEBs, instead of .ipks and .debs in most places. * Reflow prose to line-break on sentence ends, for easier diffing. * Minor content changes for clarity. Signed-off-by: Alex Stewart <alex.stewart@emerson.com>
amstewart
force-pushed
the
dev/opkg-intro
branch
from
a51fc44 to
b8f9f4c
Compare
Patch V2
|
There was a problem hiding this comment.
Pull Request Overview
This PR cleans up and improves the RST documentation for opkg tutorials by addressing minor formatting issues and improving readability. The changes focus on:
- Replacing bold formatting with inline literal markup for code elements and applications
- Changing references from ".ipks" and ".debs" to "IPKs" and "DEBs" for consistency
- Reflowing prose to break on sentence boundaries for better diff readability
- Minor content clarifications and link reference improvements
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 7 comments.
| File | Description |
|---|---|
| docs/source/opkg/opkg_intro.rst | Updates formatting, terminology, and prose flow for the basic opkg tutorial |
| docs/source/opkg/dkms_opkg.rst | Applies similar formatting and terminology improvements to the DKMS-based kernel module tutorial |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| :helloworld.c: The C source code | ||
| :CONTROL: The control file for the package | ||
| :debian-binary: The debian-binary file |
There was a problem hiding this comment.
The colon-based syntax is incorrect for RST field lists. This should use proper RST field list syntax with indented content or use a different format like definition lists.
| :helloworld.c: The C source code | |
| :CONTROL: The control file for the package | |
| :debian-binary: The debian-binary file | |
| helloworld.c | |
| The C source code | |
| CONTROL | |
| The control file for the package | |
| debian-binary | |
| The debian-binary file |
| :preinst: The ``preinst`` script will be run before the installation of the package files. | ||
|
|
||
| postinst | ||
| ~~~~~~~~ | ||
| :postinst: The ``postinst`` script will be run upon finishing the installation of the package files. | ||
|
|
||
| The postinst script will be run upon finishing the installation of the | ||
| package files. | ||
| :prerm: The ``prerm`` script will be run by opkg before any files are removed during package removal. | ||
|
|
||
| premrm | ||
| ~~~~~~ | ||
| :postrm: The ``postrm`` script will be run by opkg after files are removed during package removal. |
There was a problem hiding this comment.
The colon-based syntax is incorrect for RST field lists. This should use proper RST field list syntax with indented content or use a different format like definition lists.
| :preinst: The ``preinst`` script will be run before the installation of the package files. | ||
|
|
||
| postinst | ||
| ~~~~~~~~ | ||
| :postinst: The ``postinst`` script will be run upon finishing the installation of the package files. | ||
|
|
||
| The postinst script will be run upon finishing the installation of the | ||
| package files. | ||
| :prerm: The ``prerm`` script will be run by opkg before any files are removed during package removal. | ||
|
|
||
| premrm | ||
| ~~~~~~ | ||
| :postrm: The ``postrm`` script will be run by opkg after files are removed during package removal. |
There was a problem hiding this comment.
The colon-based syntax is incorrect for RST field lists. This should use proper RST field list syntax with indented content or use a different format like definition lists.
| :preinst: The ``preinst`` script will be run before the installation of the package files. | ||
|
|
||
| postinst | ||
| ~~~~~~~~ | ||
| :postinst: The ``postinst`` script will be run upon finishing the installation of the package files. | ||
|
|
||
| The postinst script will be run upon finishing the installation of the | ||
| package files. | ||
| :prerm: The ``prerm`` script will be run by opkg before any files are removed during package removal. | ||
|
|
||
| premrm | ||
| ~~~~~~ | ||
| :postrm: The ``postrm`` script will be run by opkg after files are removed during package removal. |
There was a problem hiding this comment.
The colon-based syntax is incorrect for RST field lists. This should use proper RST field list syntax with indented content or use a different format like definition lists.
| :preinst: The ``preinst`` script will be run before the installation of the package files. | ||
|
|
||
| postinst | ||
| ~~~~~~~~ | ||
| :postinst: The ``postinst`` script will be run upon finishing the installation of the package files. | ||
|
|
||
| The postinst script will be run upon finishing the installation of the | ||
| package files. | ||
| :prerm: The ``prerm`` script will be run by opkg before any files are removed during package removal. | ||
|
|
||
| premrm | ||
| ~~~~~~ | ||
| :postrm: The ``postrm`` script will be run by opkg after files are removed during package removal. |
There was a problem hiding this comment.
The colon-based syntax is incorrect for RST field lists. This should use proper RST field list syntax with indented content or use a different format like definition lists.
| .. code:: bash | ||
| gcc –o hello helloworld.c | ||
| gcc -o hello helloworld.c |
There was a problem hiding this comment.
The command uses a single dash (-) instead of double dash (--) for the output flag. It should be gcc -o hello helloworld.c which is correct, but the original had an en-dash (–) which was properly corrected to a regular hyphen (-).
| If problems are encountered, posting to the `NI Linux Real-Time | ||
| Community <https://forums.ni.com/t5/NI-Linux-Real-Time/ct-p/7013>`__ or | ||
| other Linux discussion boards is the recommended way to get further | ||
| guidance. |
There was a problem hiding this comment.
Line 22 contains an orphaned word 'guidance.' that appears to be leftover from incomplete editing. This should be removed or the sentence should be completed properly.
| guidance. |
1 participant
Summary
Testing
make htmllocally and manually validated that the opkg tutorials look better and the links work.