This shows you the differences between two versions of the page.
Both sides previous revision Previous revision | Next revision Both sides next revision | ||
devel:module-docbook-readme [2015/02/04 17:19] oej [Section IDs] |
devel:module-docbook-readme [2020/08/12 16:47] miconda [Writing Docbook Files for Module Readme] |
||
---|---|---|---|
Line 6: | Line 6: | ||
make modules-readme modules=modules/ | make modules-readme modules=modules/ | ||
</ | </ | ||
+ | |||
+ | Note: after the new module has been published to the public git repository, do not generate anymore the README for pushing it to git. Push only the changes to the xml files, because the README is automatically generated by a cron service running on project infrastructure to ensure coherent formatting and avoid conflicts of backporting to older branches. Of course, you can generate it locally to check if the results is the expected one, but then restore the old README without changes -- it can be done with: | ||
+ | |||
+ | < | ||
+ | rm src/ | ||
+ | git checkout src/ | ||
+ | </ | ||
+ | |||
===== Naming Files ===== | ===== Naming Files ===== |