Mercurial > hg > kdocs

annotate make/README @ 112:7da9bd82122c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Remove --long option, always do full documentation generation instead.
author Rob Landley <rob@landley.net>
date Mon, 02 May 2011 14:19:11 -0500
parents 01b77829d010
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
110
01b77829d010 Lots of stuff bit-rotted in scripts to extract documentation from current kernel sources. De-bit-rot it.
Rob Landley <rob@landley.net>
parents:
diff changeset
1 Run make/mirror.py to download resources we mirror from elsewhere into
01b77829d010 Lots of stuff bit-rotted in scripts to extract documentation from current kernel sources. De-bit-rot it.
Rob Landley <rob@landley.net>
parents:
diff changeset
2 the "mirror" directory.
01b77829d010 Lots of stuff bit-rotted in scripts to extract documentation from current kernel sources. De-bit-rot it.
Rob Landley <rob@landley.net>
parents:
diff changeset
3
01b77829d010 Lots of stuff bit-rotted in scripts to extract documentation from current kernel sources. De-bit-rot it.
Rob Landley <rob@landley.net>
parents:
diff changeset
4 Run make/splitols.py to break up the OLS proceedings into individual
01b77829d010 Lots of stuff bit-rotted in scripts to extract documentation from current kernel sources. De-bit-rot it.
Rob Landley <rob@landley.net>
parents:
diff changeset
5 papers. (Run mirror.py and install pdftk first.)
01b77829d010 Lots of stuff bit-rotted in scripts to extract documentation from current kernel sources. De-bit-rot it.
Rob Landley <rob@landley.net>
parents:
diff changeset
6
01b77829d010 Lots of stuff bit-rotted in scripts to extract documentation from current kernel sources. De-bit-rot it.
Rob Landley <rob@landley.net>
parents:
diff changeset
7 Run make/make.sh to rebuild documentation extracted from the kernel
01b77829d010 Lots of stuff bit-rotted in scripts to extract documentation from current kernel sources. De-bit-rot it.
Rob Landley <rob@landley.net>
parents:
diff changeset
8 source tarball. You may want to set $WEBDIR and $LNXDIR to values appropriate
01b77829d010 Lots of stuff bit-rotted in scripts to extract documentation from current kernel sources. De-bit-rot it.
Rob Landley <rob@landley.net>
parents:
diff changeset
9 for your system, and install mercurial and xmlto first. This calls most
01b77829d010 Lots of stuff bit-rotted in scripts to extract documentation from current kernel sources. De-bit-rot it.
Rob Landley <rob@landley.net>
parents:
diff changeset
10 of the other scripts in this directory.
01b77829d010 Lots of stuff bit-rotted in scripts to extract documentation from current kernel sources. De-bit-rot it.
Rob Landley <rob@landley.net>
parents:
diff changeset
11
01b77829d010 Lots of stuff bit-rotted in scripts to extract documentation from current kernel sources. De-bit-rot it.
Rob Landley <rob@landley.net>
parents:
diff changeset
12 Run make/doclinkcheck.py to check the Documentation/index.html files for
01b77829d010 Lots of stuff bit-rotted in scripts to extract documentation from current kernel sources. De-bit-rot it.
Rob Landley <rob@landley.net>
parents:
diff changeset
13 404 errors or files not mentioned from the index. (These are generated
01b77829d010 Lots of stuff bit-rotted in scripts to extract documentation from current kernel sources. De-bit-rot it.
Rob Landley <rob@landley.net>
parents:
diff changeset
14 from 00-INDEX files in each subdirectory, so the errors it reports should
01b77829d010 Lots of stuff bit-rotted in scripts to extract documentation from current kernel sources. De-bit-rot it.
Rob Landley <rob@landley.net>
parents:
diff changeset
15 be fixed upstream in the Linux kernel source.)