Skip to content
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.

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

DOCTEAM-1114 - SMART DOCS - Modifying kernel boot parameters #210

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

sounix000
Copy link
Contributor

@sounix000 sounix000 commented Oct 6, 2023

Description

Smart docs on the topic "Modifying kernel boot parameters"

Are there any relevant issues/feature requests?

Is this (based on) existing content?

  • I used an existing but abandoned module as the starting point, and modified it such that almost nothing of the original content remains. The modules in this PR are as good as a new one started from scratch.

@sounix000 sounix000 changed the title Draft content DOCTEAM-1114 - SMART DOCS - Modifying kernel boot parameters Oct 6, 2023
@sounix000 sounix000 force-pushed the ssarkar/DOCTEAM-1114-SMART-DOCS-modifying-kernel-boot-parameters branch 2 times, most recently from 66f768d to 6ea81b8 Compare October 12, 2023 04:55
@sounix000 sounix000 force-pushed the ssarkar/DOCTEAM-1114-SMART-DOCS-modifying-kernel-boot-parameters branch 3 times, most recently from 809d8b7 to ea55420 Compare October 25, 2023 06:06
@sounix000 sounix000 marked this pull request as ready for review October 25, 2023 07:04
@sounix000 sounix000 force-pushed the ssarkar/DOCTEAM-1114-SMART-DOCS-modifying-kernel-boot-parameters branch from 8d2ada6 to ab40e3f Compare October 25, 2023 07:05
tomschr

This comment was marked as resolved.

Copy link
Contributor

@fsundermeyer fsundermeyer left a comment

Choose a reason for hiding this comment

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

Overall, a very good first attempt. I think what is still missing, is some explanation when fiddling with Kernel parameters is need/wanted (e.g. tuning? troubleshooting, energy saving, etc). For this you should speak to SMEs.
And before this gets published, it needs to be turned into topics and an assembly,
Thanks Souvik!

xml/task-modify-kernel-boot-parameters.xml Outdated Show resolved Hide resolved
xml/task-modify-kernel-boot-parameters.xml Outdated Show resolved Hide resolved
xml/task-modify-kernel-boot-parameters.xml Outdated Show resolved Hide resolved
<screen>setparams '&productname; &productnumber;'
<procedure>
<para>
To temporarily disable the splash screen, proceed as follows:
Copy link
Contributor

Choose a reason for hiding this comment

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

It is not clear that this is just an example. I would move this into the previous paragrtaph saying: In the following example, the splash screen is temporarily disabled.

Maybe you also shopuld add and modify a parameter with this example to cover the three most common use-cases.

Also, some general rules should be mentioned, such as that parameters are separated by space. And (if applicable, not sure) how to correctly quote or escape if a value contains a space. Maybe even move this into a general introduction, because it applies to both, temporarily and permanently modifying parameters.

xml/task-modify-kernel-boot-parameters.xml Outdated Show resolved Hide resolved
xml/task-modify-kernel-boot-parameters.xml Outdated Show resolved Hide resolved
@sounix000 sounix000 force-pushed the ssarkar/DOCTEAM-1114-SMART-DOCS-modifying-kernel-boot-parameters branch from 7ddefed to 213a418 Compare November 3, 2023 07:53
@sounix000 sounix000 force-pushed the ssarkar/DOCTEAM-1114-SMART-DOCS-modifying-kernel-boot-parameters branch 2 times, most recently from 3e043c3 to 47d23b5 Compare November 16, 2023 07:18
@taroth21

This comment was marked as resolved.

@sounix000 sounix000 force-pushed the ssarkar/DOCTEAM-1114-SMART-DOCS-modifying-kernel-boot-parameters branch 2 times, most recently from 9217dd7 to 3ff519b Compare November 28, 2023 06:11
@sounix000 sounix000 force-pushed the ssarkar/DOCTEAM-1114-SMART-DOCS-modifying-kernel-boot-parameters branch 2 times, most recently from 30183f9 to f52c088 Compare December 11, 2023 10:27
@sounix000 sounix000 force-pushed the ssarkar/DOCTEAM-1114-SMART-DOCS-modifying-kernel-boot-parameters branch from 1c5d5f3 to 5fbf5a6 Compare December 18, 2023 11:12
@sounix000 sounix000 force-pushed the ssarkar/DOCTEAM-1114-SMART-DOCS-modifying-kernel-boot-parameters branch 2 times, most recently from 47c85f2 to 569c217 Compare January 3, 2024 10:21
Copy link
Contributor

@taroth21 taroth21 left a comment

Choose a reason for hiding this comment

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

Thanks for overhauling and very well done! I know the editorial review is still to follow after the content review. Nevertheless, I included some code suggestions for typos or other small things that I spotted during the content review. More feedback to come via mail - many thanks!

@sounix000 sounix000 force-pushed the ssarkar/DOCTEAM-1114-SMART-DOCS-modifying-kernel-boot-parameters branch from 567ee30 to c99045f Compare January 19, 2024 11:35
@taroth21 taroth21 force-pushed the ssarkar/DOCTEAM-1114-SMART-DOCS-modifying-kernel-boot-parameters branch from 523f9f6 to d16acbe Compare January 19, 2024 15:53
@sounix000 sounix000 force-pushed the ssarkar/DOCTEAM-1114-SMART-DOCS-modifying-kernel-boot-parameters branch from d16acbe to e512796 Compare January 22, 2024 10:04
@sounix000 sounix000 force-pushed the ssarkar/DOCTEAM-1114-SMART-DOCS-modifying-kernel-boot-parameters branch 3 times, most recently from 0bb5b0f to 44647bf Compare February 5, 2024 06:24
intermediate changes

intermediate changes

draft content complete

Solved build problem by changing root element from topic to article

Fixed typo

trivial changes

Fixes based on review comments

Splitting DC file into two for profiling using PROFOS

intermediate changes

total revamp of core content

restructuring in progress

Intermediate changes in assembly structure

rearrangements

temporary and permanent procedure modularization

linuxrc difference partial modularization

complete modularization; attempting solution of build errors

build problem solved

removed the generic profiling dc file
@sounix000 sounix000 force-pushed the ssarkar/DOCTEAM-1114-SMART-DOCS-modifying-kernel-boot-parameters branch from 44647bf to 6dc5f00 Compare March 4, 2024 05:41
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.

4 participants