Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!

Bug 59164

Summary: review new hardened docs for mass consumption
Product: [OLD] Docs-user Reporter: Brandon Hale (RETIRED) <tseng>
Component: Submit NewAssignee: Brandon Hale (RETIRED) <tseng>
Status: RESOLVED FIXED    
Severity: normal CC: docs-team, hardened, swift
Priority: High    
Version: unspecified   
Hardware: All   
OS: Linux   
URL: http://dev.gentoo.org/~tseng/xml/
Whiteboard:
Package list:
Runtime testing required: ---
Attachments: general overview of technologies (glossary?)
pax/hardened toolchain howto
Glossary document, reviewed
Updated pax-howto.xml
"Broken" glossary

Description Brandon Hale (RETIRED) gentoo-dev 2004-08-02 09:43:17 UTC
Attached are documents for the second gen Hardened toolchain and PaX kernel.
Please review these for general user readiness.

Reproducible: Always
Steps to Reproduce:
Comment 1 Brandon Hale (RETIRED) gentoo-dev 2004-08-02 09:44:16 UTC
Created attachment 36645 [details]
general overview of technologies (glossary?)
Comment 2 Brandon Hale (RETIRED) gentoo-dev 2004-08-02 09:44:42 UTC
Created attachment 36646 [details]
pax/hardened toolchain howto
Comment 3 Sven Vermeulen (RETIRED) gentoo-dev 2004-08-07 05:32:57 UTC
Created attachment 36940 [details]
Glossary document, reviewed

I've added ID-tags to the document so you can immediately go to
"glossary.xml#prelude" if you want to read up on prelude. Also fixed a few
typo's (but might have missed a couple as well).
Comment 4 Sven Vermeulen (RETIRED) gentoo-dev 2004-08-07 05:44:34 UTC
Created attachment 36941 [details]
Updated pax-howto.xml

Not much to say here; removed a few comma's and the reference to PageExec being
a performance-hit as most users will use the new sources with improved PageExec
anyway when reading this document.
Comment 5 Sven Vermeulen (RETIRED) gentoo-dev 2004-08-07 05:47:36 UTC
Okay, both documents have been reviewed. I haven't placed the required 
  <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
inside yet but *they must* be added before they are committed!

Anyway, a few remarks:
1. Make sure that the <guide link="..."> points to the location where the document is stored
2. Perhaps you might want to consider having a documentation-specific part for Hardened, i.e. /proj/en/hardened/docs or similar? If I still have commit access I'd be glad to start up with that, write a (currently very small :) index and link it from the main documentation page.
Comment 6 Brandon Hale (RETIRED) gentoo-dev 2004-08-07 07:31:05 UTC
Created attachment 36956 [details]
"Broken" glossary

made a few small edits, the pre-commit checker is barfing on this.
Comment 7 Brandon Hale (RETIRED) gentoo-dev 2004-08-07 07:31:49 UTC
Checker seyz:

XML-Checking glossary.xml ... 
XML-Checking index.xml ... 
index.xml:111: element p: validity error : Element p is not declared in p list of possible children
</p>
    ^
index.xml:111: element p: validity error : Element p is not declared in p list of possible children
</p>
    ^
index.xml:111: element p: validity error : Element p is not declared in p list of possible children
</p>
    ^
index.xml:111: element p: validity error : Element p is not declared in p list of possible children
</p>
    ^
index.xml:113: element body: validity error : Element body content does not follow the DTD, expecting (box | figure | fig | note | impo | warn | pre | p | table | ul | ol)*, got (CDATA p )
</body>
       ^
cvs commit: Pre-commit check failed
cvs [commit aborted]: correct above errors first!
Comment 8 Xavier Neys (RETIRED) gentoo-dev 2004-08-07 07:39:25 UTC
glossary.xml is OK
the problem is in your index.xml
Comment 9 Brandon Hale (RETIRED) gentoo-dev 2004-08-07 08:06:09 UTC
/me cant read..

After fighting with it a bit more (abstract has to be before lisence?)
I got it all commmited. Thanks guys.