Opened 5 years ago
Closed 5 years ago
#1721 closed defect (fixed)
Some installation instructions are not generated correctly when using porg
| Reported by: | Pierre Labastie | Owned by: | |
|---|---|---|---|
| Priority: | normal | Milestone: | 3.0 |
| Component: | ablfs | Version: | SVN |
| Severity: | normal | Keywords: | |
| Cc: |
Description
Generating installation instructions for BLFS, taking into account whether running as user or root, whether using porg, destdir package management or nothing is a complicated task because markup in the book is not very accurate:
- The only indication telling a <screen><userinput> tag is an installation instructions is that <screen> has a role="root" attribute, and that the tag occurs in a sect2 with role="installation" attribute. But some of those tags are not installation instructions: for example, they can be user or group adding, or some database updating (mime, desktop, icons, ...).
- There may be several <screen><userinput> tags, which should be grouped in order to generate the porg logging correctly. But if they are interspersed with config instructions, this is hard...
This may lead to buggy instructions, for example beginning with porg opening stanzas and finishing without closing stanzas, or converse... Also, some single quotes may be escaped (as '\''), when not needed, leading to errors when running the script...
This can be improved in two directions:
- improve the stylesheet generating those instructions.
- improve the book itself so that different types of instructions are more clearly identified (and of course adapt the stylesheet to use that).
Note:
See TracTickets
for help on using tickets.
One first thing to do is to have more than two modes for outputting instructions (right now, with only have mode="root", and no mode). Also, checking that there is no role"root" before for outputting porg stanzas may be not enough, same for no role="root" after for closing...