841883 - manpages+html for tools: fix dependency tracking, integrate into build system

Status: RESOLVED FIXED

(NSS :: Documentation, defect)

Description

[Kai Engert (:KaiE:)]

The current documentation at security/doc is an optional build that must be triggered manually.
It creates temporary files, that one needs to clean up manually afterwards.
We don't have readable snapshots of the documentation checked in yet (only the docbook master).

I have a patch to fix the above. It will:

- add security/doc/nroff and security/doc/html directories
- add generated man pages and html documents
- fix the dependencies in doc/Makefile, it will only rebuild changed objects
- add various .cvsignore files to ignore the temporary build files
- in the master nss/Makefile (the one where we have nss_build_all etc.)
  add new build targets build_docs and clean_docs
  (which will simply go to subdirectory doc and run "make" or "make clean"
   respectively)

Comment 1

[Kai Engert (:KaiE:)]

Attachment: Patch v1

This file excludes the generated *.1 and *.html files for brevity.

Comment 2

[Kai Engert (:KaiE:)]

Checking in Makefile;
/cvsroot/mozilla/security/nss/Makefile,v  <--  Makefile
new revision: 1.45; previous revision: 1.44
done
RCS file: /cvsroot/mozilla/security/nss/doc/.cvsignore,v
done
Checking in doc/.cvsignore;
/cvsroot/mozilla/security/nss/doc/.cvsignore,v  <--  .cvsignore
initial revision: 1.1
done
Checking in doc/Makefile;
/cvsroot/mozilla/security/nss/doc/Makefile,v  <--  Makefile
new revision: 1.2; previous revision: 1.1
done
RCS file: /cvsroot/mozilla/security/nss/doc/html/.cvsignore,v
done
Checking in doc/html/.cvsignore;
/cvsroot/mozilla/security/nss/doc/html/.cvsignore,v  <--  .cvsignore
initial revision: 1.1
done
RCS file: /cvsroot/mozilla/security/nss/doc/html/certutil.html,v
done
Checking in doc/html/certutil.html;
/cvsroot/mozilla/security/nss/doc/html/certutil.html,v  <--  certutil.html
initial revision: 1.1
done
RCS file: /cvsroot/mozilla/security/nss/doc/html/cmsutil.html,v
done
Checking in doc/html/cmsutil.html;
/cvsroot/mozilla/security/nss/doc/html/cmsutil.html,v  <--  cmsutil.html
initial revision: 1.1
done
RCS file: /cvsroot/mozilla/security/nss/doc/html/crlutil.html,v
done
Checking in doc/html/crlutil.html;
/cvsroot/mozilla/security/nss/doc/html/crlutil.html,v  <--  crlutil.html
initial revision: 1.1
done
RCS file: /cvsroot/mozilla/security/nss/doc/html/derdump.html,v
done
Checking in doc/html/derdump.html;
/cvsroot/mozilla/security/nss/doc/html/derdump.html,v  <--  derdump.html
initial revision: 1.1
done
RCS file: /cvsroot/mozilla/security/nss/doc/html/modutil.html,v
done
Checking in doc/html/modutil.html;
/cvsroot/mozilla/security/nss/doc/html/modutil.html,v  <--  modutil.html
initial revision: 1.1
done
RCS file: /cvsroot/mozilla/security/nss/doc/html/pk12util.html,v
done
Checking in doc/html/pk12util.html;
/cvsroot/mozilla/security/nss/doc/html/pk12util.html,v  <--  pk12util.html
initial revision: 1.1
done
RCS file: /cvsroot/mozilla/security/nss/doc/html/pp.html,v
done
Checking in doc/html/pp.html;
/cvsroot/mozilla/security/nss/doc/html/pp.html,v  <--  pp.html
initial revision: 1.1
done
RCS file: /cvsroot/mozilla/security/nss/doc/html/signtool.html,v
done
Checking in doc/html/signtool.html;
/cvsroot/mozilla/security/nss/doc/html/signtool.html,v  <--  signtool.html
initial revision: 1.1
done
RCS file: /cvsroot/mozilla/security/nss/doc/html/signver.html,v
done
Checking in doc/html/signver.html;
/cvsroot/mozilla/security/nss/doc/html/signver.html,v  <--  signver.html
initial revision: 1.1
done
RCS file: /cvsroot/mozilla/security/nss/doc/html/ssltap.html,v
done
Checking in doc/html/ssltap.html;
/cvsroot/mozilla/security/nss/doc/html/ssltap.html,v  <--  ssltap.html
initial revision: 1.1
done
RCS file: /cvsroot/mozilla/security/nss/doc/html/vfychain.html,v
done
Checking in doc/html/vfychain.html;
/cvsroot/mozilla/security/nss/doc/html/vfychain.html,v  <--  vfychain.html
initial revision: 1.1
done
RCS file: /cvsroot/mozilla/security/nss/doc/html/vfyserv.html,v
done
Checking in doc/html/vfyserv.html;
/cvsroot/mozilla/security/nss/doc/html/vfyserv.html,v  <--  vfyserv.html
initial revision: 1.1
done
RCS file: /cvsroot/mozilla/security/nss/doc/nroff/certutil.1,v
done
Checking in doc/nroff/certutil.1;
/cvsroot/mozilla/security/nss/doc/nroff/certutil.1,v  <--  certutil.1
initial revision: 1.1
done
RCS file: /cvsroot/mozilla/security/nss/doc/nroff/cmsutil.1,v
done
Checking in doc/nroff/cmsutil.1;
/cvsroot/mozilla/security/nss/doc/nroff/cmsutil.1,v  <--  cmsutil.1
initial revision: 1.1
done
RCS file: /cvsroot/mozilla/security/nss/doc/nroff/crlutil.1,v
done
Checking in doc/nroff/crlutil.1;
/cvsroot/mozilla/security/nss/doc/nroff/crlutil.1,v  <--  crlutil.1
initial revision: 1.1
done
RCS file: /cvsroot/mozilla/security/nss/doc/nroff/derdump.1,v
done
Checking in doc/nroff/derdump.1;
/cvsroot/mozilla/security/nss/doc/nroff/derdump.1,v  <--  derdump.1
initial revision: 1.1
done
RCS file: /cvsroot/mozilla/security/nss/doc/nroff/modutil.1,v
done
Checking in doc/nroff/modutil.1;
/cvsroot/mozilla/security/nss/doc/nroff/modutil.1,v  <--  modutil.1
initial revision: 1.1
done
RCS file: /cvsroot/mozilla/security/nss/doc/nroff/pk12util.1,v
done
Checking in doc/nroff/pk12util.1;
/cvsroot/mozilla/security/nss/doc/nroff/pk12util.1,v  <--  pk12util.1
initial revision: 1.1
done
RCS file: /cvsroot/mozilla/security/nss/doc/nroff/pp.1,v
done
Checking in doc/nroff/pp.1;
/cvsroot/mozilla/security/nss/doc/nroff/pp.1,v  <--  pp.1
initial revision: 1.1
done
RCS file: /cvsroot/mozilla/security/nss/doc/nroff/signtool.1,v
done
Checking in doc/nroff/signtool.1;
/cvsroot/mozilla/security/nss/doc/nroff/signtool.1,v  <--  signtool.1
initial revision: 1.1
done
RCS file: /cvsroot/mozilla/security/nss/doc/nroff/signver.1,v
done
Checking in doc/nroff/signver.1;
/cvsroot/mozilla/security/nss/doc/nroff/signver.1,v  <--  signver.1
initial revision: 1.1
done
RCS file: /cvsroot/mozilla/security/nss/doc/nroff/ssltap.1,v
done
Checking in doc/nroff/ssltap.1;
/cvsroot/mozilla/security/nss/doc/nroff/ssltap.1,v  <--  ssltap.1
initial revision: 1.1
done
RCS file: /cvsroot/mozilla/security/nss/doc/nroff/vfychain.1,v
done
Checking in doc/nroff/vfychain.1;
/cvsroot/mozilla/security/nss/doc/nroff/vfychain.1,v  <--  vfychain.1
initial revision: 1.1
done
RCS file: /cvsroot/mozilla/security/nss/doc/nroff/vfyserv.1,v
done
Checking in doc/nroff/vfyserv.1;
/cvsroot/mozilla/security/nss/doc/nroff/vfyserv.1,v  <--  vfyserv.1
initial revision: 1.1
done

Comment 3

[Elio Maldonado]

Attachment: Fix paths in the build_docs and clean_docs targets for new hg source layout

Comment 4

[Kai Engert (:KaiE:)]

Comment on attachment 720834 [details] [diff] [review]
Fix paths in the build_docs and clean_docs targets for new hg source layout

r=kaie