This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
lkmp:lkmp_task_list [2019/10/23 17:41] ShuahKhanLF |
lkmp:lkmp_task_list [2020/01/07 20:05] (current) BjornHelgaas |
||
---|---|---|---|
Line 3: | Line 3: | ||
==== Documentation conversion and updates ==== | ==== Documentation conversion and updates ==== | ||
- | The following directories have several .txt file. Please pick 2 files and convert to ReST. There are a few exceptions that should be kept as plain text files. | + | The following directories have several .txt files. Please pick two files and convert to ReST. There are a few exceptions that should be kept as plain text files: |
* a configuration file whose extension is .txt; | * a configuration file whose extension is .txt; | ||
- | * a dump of chapter extracted from an old arch-specific manual with seems to be provided by its manufacturer. | + | * a dump of chapter extracted from an old arch-specific manual which seems to be provided by its manufacturer. |
**Preparing to build the documentation:** | **Preparing to build the documentation:** | ||
- | There's a script with checks if you have all needed dependencies to build the documentation. It is called automatically when you run ''make htmldocs''. Alternatively, you can call the script directly with: | + | There's a script that checks if you have all needed dependencies to build the documentation. It is called automatically when you run ''make htmldocs''. Alternatively, you can call the script directly with: |
<code> | <code> | ||
Line 16: | Line 16: | ||
</code> | </code> | ||
- | **Building docs and looking for warns:** | + | **Building docs and looking for warnings:** |
Once you have all the requirements, you can do the building with: | Once you have all the requirements, you can do the building with: |