diff --git a/winsup/cygwin/shared.sgml b/winsup/cygwin/shared.sgml index d55eb6e65..b8d111a55 100644 --- a/winsup/cygwin/shared.sgml +++ b/winsup/cygwin/shared.sgml @@ -5,7 +5,7 @@ shared_info * cygwin_getshared - + Returns a pointer to an internal Cygwin memory structure diff --git a/winsup/cygwin/stackdump.sgml b/winsup/cygwin/stackdump.sgml index e0ac0e0fc..1969e2e6f 100644 --- a/winsup/cygwin/stackdump.sgml +++ b/winsup/cygwin/stackdump.sgml @@ -4,7 +4,7 @@ extern "C" void cygwin_stackdump - + Outputs a stackdump to stderr from the called location. diff --git a/winsup/doc/ChangeLog b/winsup/doc/ChangeLog index 0795510a5..b346f5305 100644 --- a/winsup/doc/ChangeLog +++ b/winsup/doc/ChangeLog @@ -1,3 +1,9 @@ +2004-12-27 Joshua Daniel Franklin + + * Makefile.in: Update to use xmlto. + * cygwin.dsl: Change into DocBook XSL stylesheet for xmlto. + * pathnames.sgml: Correct documentation of mount behavior. + 2004-12-24 Joshua Daniel Franklin * cygserver.sgml: Cleanup markup for XML validity. diff --git a/winsup/doc/Makefile.in b/winsup/doc/Makefile.in index 94a8eb8b5..87a72d107 100644 --- a/winsup/doc/Makefile.in +++ b/winsup/doc/Makefile.in @@ -40,7 +40,6 @@ all : \ cygwin-ug-net/cygwin-ug-net.html \ cygwin-ug-net.html \ cygwin-api/cygwin-api.html \ - $(DOC) \ $(HTMLDOC) clean: @@ -48,34 +47,25 @@ clean: install: all -# jw -d $(srcdir)/cygwin.dsl#html cygwin-ug-net.sgml -cygwin-ug/cygwin-ug.html : cygwin-ug.sgml doctool - -db2html -d $(srcdir)/cygwin.dsl#html $< - -cygwin-ug.sgml : cygwin-ug.in.sgml ./doctool Makefile - -./doctool -m $(SGMLDIRS) -s $(srcdir) -o $@ $< - cygwin-ug-net.html : cygwin-ug-net.sgml doctool - -jw -d $(srcdir)/cygwin.dsl#html -u $< + -xmlto html-nochunks -m $(srcdir)/cygwin.dsl $< + -cp cygwin-ug-net.html cygwin-ug-net/cygwin-ug-net-nochunks.html + -gzip cygwin-ug-net/cygwin-ug-net-nochunks.html cygwin-ug-net/cygwin-ug-net.html : cygwin-ug-net.sgml doctool - -db2html -d $(srcdir)/cygwin.dsl#html $< + -xmlto html -o cygwin-ug-net/ -m $(srcdir)/cygwin.dsl $< + -mv cygwin-ug-net/index.html cygwin-ug-net/cygwin-ug-net.html cygwin-ug-net.sgml : cygwin-ug-net.in.sgml ./doctool Makefile -./doctool -m $(SGMLDIRS) -s $(srcdir) -o $@ $< cygwin-api/cygwin-api.html : cygwin-api.sgml - -db2html -d $(srcdir)/cygwin.dsl#html $< + -xmlto html -o cygwin-api/ -m $(srcdir)/cygwin.dsl $< + -mv cygwin-api/index.html cygwin-api/cygwin-api.html cygwin-api.sgml : cygwin-api.in.sgml ./doctool Makefile -./doctool -m $(SGMLDIRS) -s $(srcdir) -o $@ $< -cygwin-api-int/cygwin-api-int.html : cygwin-api-int.sgml - -db2html -d $(srcdir)/cygwin.dsl#html $< - -cygwin-api-int.sgml : cygwin-api.in.sgml ./doctool Makefile - -./doctool -i -m $(SGMLDIRS) -s $(srcdir) -b cygwin-api-int -o $@ $< - ./doctool : doctool.c gcc -g $< -o $@ diff --git a/winsup/doc/cygwin.dsl b/winsup/doc/cygwin.dsl index bf855c19f..8c1647155 100644 --- a/winsup/doc/cygwin.dsl +++ b/winsup/doc/cygwin.dsl @@ -1,149 +1,13 @@ - - - -]]> - - -]]> -]> + + - + + + - - - + -;; The following are -;; -;; ==================== -;; customize the print stylesheet -;; ==================== + -;; make funcsynopsis look pretty -(define %funcsynopsis-decoration% - ;; Decorate elements of a FuncSynopsis? - #t) - -;; use graphics in admonitions, and have their path be "." -;; NO: we are not yet ready to use gifs in TeX and so forth -(define %admon-graphics-path% - "./") -(define %admon-graphics% - #f) - -;; this is necessary because right now jadetex does not understand -;; symbolic entities, whereas things work well with numeric entities. -(declare-characteristic preserve-sdata? - "UNREGISTERED::James Clark//Characteristic::preserve-sdata?" - #f) -(define %two-side% #t) - -(define %section-autolabel% - ;; Are sections enumerated? - #t) -;; (define %title-font-family% -;; ;; The font family used in titles -;; "Ariel") -(define %visual-acuity% - ;; General measure of document text size - ;; "presbyopic" - ;; "large-type" - "presbyopic") - -(define %generate-part-toc% #t) - - -;;; The following customizations are from Tim Waugh's selfdocbook -;;; http://cyberelk.net/tim/docbook/ -;;; -;;; TeX backend can go to PS (where EPS is needed) -;;; or to PDF (where PNG is needed). So, just -;;; omit the file extension altogether and let -;;; tex/pdfjadetex sort it out on its own. -(define (graphic-file filename) - (let ((ext (file-extension filename))) - (if (or (equal? 'backend 'tex) ;; Leave off the extension for TeX - (not filename) - (not %graphic-default-extension%) - (member ext %graphic-extensions%)) - filename - (string-append filename "." %graphic-default-extension%)))) - -;;; Full justification. -(define %default-quadding% - 'justify) - -;;; To make URLs line wrap we use the TeX 'url' package. -;;; See also: jadetex.cfg -;; First we need to declare the 'formatting-instruction' flow class. -(declare-flow-object-class formatting-instruction -"UNREGISTERED::James Clark//Flow Object Class::formatting-instruction") -;; Then redefine ulink to use it. -(element ulink - (make sequence - (if (node-list-empty? (children (current-node))) - ; ulink url="...", /ulink - (make formatting-instruction - data: (string-append "\\url{" - (attribute-string (normalize "url")) - "}")) - (if (equal? (attribute-string (normalize "url")) - (data-of (current-node))) - ; ulink url="http://...", http://..., /ulink - (make formatting-instruction data: - (string-append "\\url{" - (attribute-string (normalize "url")) - "}")) - ; ulink url="http://...", some text, /ulink - (make sequence - ($charseq$) - (literal " (") - (make formatting-instruction data: - (string-append "\\url{" - (attribute-string (normalize "url")) - "}")) - (literal ")")))))) -;;; And redefine filename to use it too. -(element filename - (make formatting-instruction - data: (string-append "\\path{" (data-of (current-node)) "}"))) - - - - - - - - -;; If true (non-zero), elements of the FuncSynopsis will be decorated -;; (e.g. bold or italic). -(define %funcsynopsis-decoration% #t) - -;; If true, a Table of Contents will be generated for each 'Article'. -(define %generate-article-toc% #t) - -;; If true, a Table of Contents will be generated for each Part. -(define %generate-part-toc% #t) - -;; The name of the stylesheet to place in the HTML LINK TAG, -;; or #f to suppress the stylesheet LINK. -(define %stylesheet% "docbook.css") - -(define %use-id-as-filename% #t) - -(define %html-ext% ".html") - - - - - - - diff --git a/winsup/doc/pathnames.sgml b/winsup/doc/pathnames.sgml index ed98d27a8..fe9133901 100644 --- a/winsup/doc/pathnames.sgml +++ b/winsup/doc/pathnames.sgml @@ -49,11 +49,15 @@ the Cygwin library (this version is not the same as the release number). The system-wide table is located under the same subkeys under HKEY_LOCAL_SYSTEM. -By default, the POSIX root / points to the -system partition but it can be relocated to any directory in the -Windows file system using the mount command. -Whenever Cygwin generates a POSIX path from a Win32 one, it uses the -longest matching prefix in the mount table. Thus, if +Since Windows uses drive letters instead of a single filesystem +root, the POSIX root / must be set to a directory +in the Windows file system using the mount command. +Without a / mount, Cygwin processes cannot +distinguish between the Windows CurrentDrive and SystemDrive. + + +Whenever Cygwin generates a POSIX path from a Win32 one, it uses +the longest matching prefix in the mount table. Thus, if C: is mounted as /c and also as /, then Cygwin would translate C:/foo/bar to /c/foo/bar.