User Tools
devel:module-docbook-readme
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision Next revision Both sides next revision | ||
|
devel:module-docbook-readme [2013/04/05 13:46] miconda created |
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 ===== | ||
| Line 42: | Line 50: | ||
| * s - statistics | * s - statistics | ||
| * e - event routes | * e - event routes | ||
| + | * v - pseudovariable | ||
| Next is an example showing the id for the section corresponding to parameter **workers** from module **async**: | Next is an example showing the id for the section corresponding to parameter **workers** from module **async**: | ||
devel/module-docbook-readme.txt ยท Last modified: 2020/08/12 16:52 by miconda
Page Tools
