This is a revision of earlier corrections to the programmers guide. At this point, it is a collaborative work of myself (Stephen), the technical writer (Nandini) and AI (Claude).
found while reviewing the DPDK programmer's guide documentation. Types of corrections include: - Grammar fixes (subject-verb agreement, articles, prepositions) - Typos and spelling errors - Function name corrections (cmdline_new_stdin -> cmdline_stdin_new) - Type name corrections (cmdline_parse_t -> cmdline_parse_inst_t) - Word errors (exasperate -> exacerbate) - RST formatting issues (section hierarchy, underline lengths) - Code formatting consistency (adding backticks around function names) - Critical content fixes (restored missing "out" in "compiled out by default") - Command syntax fixes (hugetlbfs mount command) - Consistency improvements (capitalization, hyphenation, terminology) Affected documentation: - ethdev guide: extensive grammar and punctuation cleanup - argparse library guide: articles, verb forms, typo fixes - design guide: capitalization, terminology consistency - Linux system requirements: mount command fix, spacing - service cores guide: clarity improvements - trace library guide: critical fix and grammar (2 patches) - log library guide: spelling, sentence structure - command-line library guide: function/type name corrections - stack library guide: RST hierarchy fix, grammar - RCU library guide: word errors, formatting, clarity Stephen Hemminger (11): doc: correct grammar and punctuation errors in ethdev guide doc: correct grammar and typos in argparse library guide doc: correct grammar and typos in design guide doc: correct errors in Linux system requirements guide doc: correct grammar in service cores guide doc: correct grammar and errors in trace library guide doc: correct typos in log library guide doc: correct errors in command-line library guide doc: correct errors in trace library guide doc: correct errors in stack library guide doc: correct errors in RCU library guide doc/guides/contributing/design.rst | 71 +++++----- doc/guides/linux_gsg/sys_reqs.rst | 14 +- doc/guides/prog_guide/argparse_lib.rst | 24 ++-- doc/guides/prog_guide/cmdline.rst | 42 +++--- doc/guides/prog_guide/ethdev/ethdev.rst | 168 ++++++++++++------------ doc/guides/prog_guide/log_lib.rst | 32 ++--- doc/guides/prog_guide/rcu_lib.rst | 143 ++++++++++++-------- doc/guides/prog_guide/service_cores.rst | 30 ++--- doc/guides/prog_guide/stack_lib.rst | 32 ++--- doc/guides/prog_guide/trace_lib.rst | 118 ++++++++--------- 10 files changed, 353 insertions(+), 321 deletions(-) -- 2.51.0
