summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2018-03-23Fix callbacks signatures in libSM documentationFab
https://bugs.freedesktop.org/show_bug.cgi?id=103135 Reviewed-by: Alan Coopersmith <alan.coopersmith@oracle.com> Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2012-01-11informaltable cleanupMatt Dew
On certain tables, add top and bottom borders to table header and a bottom border to the table. This matches what those tables in the old pdfs looked like. the <?dbfo keep-together='always'> prevents tables from splitting across pages. Useful for tiny tables. Converting the colwidth to a floating point, IE, 1* -> 1.0* cleans up these build errors: WARNING: table-layout="fixed" and column-width unspecified => falling back to proportional-column-width(1) Signed-off-by: Matt Dew <marcoz@osource.org>
2011-12-09SmsInitialize: Mark vendor & release args as const char *Alan Coopersmith
Needed to fix gcc -Wwrite-strings arguments in callers such as xsm. Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com> Reviewed-by: James Cloos <cloos@jhcloos.com>
2011-10-04Cleanup IDs and links in docMatt Dew
1 - fix the capitalization of the ID attributes to match either the <title> or <funcdef> string it goes with. 2 - fix any <linkend>'s that were affected by 1. 3 - any <function> in the docs that has an actual funcdef, will become an olink. Signed-off-by: Matt Dew <marcoz@osource.org>
2011-09-16Strip trailing whitespaceAlan Coopersmith
Performed with: find * -type f | xargs perl -i -p -e 's{[ \t]+$}{}' git diff -w & git diff -b show no diffs from this change Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2011-09-14docs: fix author affiliationGaetan Nadon
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2011-09-12docs: use the &fullrelvers; entity to set X11 release informationGaetan Nadon
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2011-09-11docs: remove <productnumber> which is not used by defaultGaetan Nadon
This element is not rendered by default on the title. A template customization is required to display it. X Window System does not have a product number. Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2011-06-12Install xml versions of specs even if HAVE_XMLTO is falseGaetan Nadon
DocBook/XML input source is also a usefull output format that can be viewed with an XML viewer or editor and by some O/S help system. Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2011-06-04add id attributes to funcsynopsis to allow other docs to olink to them.Matt Dew
Signed-off-by: Matt Dew <marcoz@osource.org> Reviewed-by: Alan Coopersmith <alan.coopersmith@oracle.com> Reviewed-by: Gaetan Nadon <memsize@videotron.ca>
2011-03-30Documentation: add Docbook external references supportGaetan Nadon
When writing technical documentation, it is often necessary to cross reference to other information. When that other information is not in the current document, additional support is needed, namely <olink>. A new feature with version 1.7 of xorg-sgml-doctools adds references to other documents within or outside this package. This patch adds technical support for this feature but does not change the content of the documentation as seen by the end user. Each book or article must generate a database containing the href of sections that can be referred to from another document. This database is installed in DATAROOTDIR/sgml/X11/dbs. There is a requirement that the value of DATAROOTDIR for xorg-sgml-doctools and for the package documentation is the same. This forms a virtual document tree. This database is consulted by other documents while they are being generated in order to fulfill the missing information for linking. Refer to the xorg-sgml-doctools for further technical information. Co-authored-by: Matt Dew <marcoz@osource.org> Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2011-02-25Docbook: change the book id to match the xml file basenameGaetan Nadon
This is required for the up-coming external references support. Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2010-12-16Use docbookx.dtd version 4.3 for all docsPaulo Zanoni
Signed-off-by: Paulo Zanoni <pzanoni@mandriva.com> Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-11-09config: HTML file generation: use the installed copy of xorg.cssGaetan Nadon
Currenlty the xorg.css file is copied in each location where a DocBook/XML file resides. This produces about 70 copies in the $(docdir) install tree. Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2010-10-24SMlib.xml: Use <simplelist> instead of <synopsis> for lists of mask valuesAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-10-24SMlib.xml: Tag function names, parameters, constant values, etc.Alan Coopersmith
Includes correcting <function> tags on things that aren't functions as some stylesheets may add () after <function> tagged items so we shouldn't use them for constants, variables, filenames, etc. Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-10-24SMlib.xml: Line wrapping & other whitespace cleanupAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-10-23xsmp.xml: add internal cross-reference linksAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-10-23xsmp.xml: Use <synopsis> and related markup for protocol message definitionAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-10-23xsmp.xml: Use <errorname> instead of <function> for error namesAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-10-22xsmp.xml: Restore note titles (example/rationale/advice)Alan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-10-22xsmp.xml: Clean up tablesAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-10-22xsmp.xml: Misc markup tag cleanupsAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-10-22Coalesce copyright notices in xml docsAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-10-22xsmp.xml: Convert -> & <- to &rarr; & &larr;Alan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-10-22xsmp.xml: Line wrapping & other whitespace cleanupAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-10-21SMlib.xml: fix a couple parameter list entriesAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-10-21SMlib.xml: misc markup cleanupsAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-10-21SMlib.xml: fix typo: SmProc -> SmPropAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-10-21SMlib.xml: add internal cross-reference linksAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-10-21SMlib.xml: Convert remaining `` quotes to &ldquo; styleAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-10-21SMlib.xml: Convert remaining literallayout tags to synopsis tagsAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-10-21SMlib.xml: Convert function prototypes to <funcprototype> tagsAlan Coopersmith
Provides automatic ansifaction & better formatted output Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-10-21SMlib.xml: Remove some nroff macros left in tables by mistakeAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-06-27doc: remove trailing spaces in DocBook XML docsGaetan Nadon
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2010-06-26doc: replace groff input format with docbook xml formatGaetan Nadon
Initial version of SMlib and xsmp docbook xml. Requires util-macros 1.10 Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2010-02-16doc: use HAVE_GROFF_MS to skip doc when 's.tmac' macros missingGaetan Nadon
This conditional is defined in XORG_WITH_GROFF macro. Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2010-02-16specs: change install cmd due to automake 1.11Gaetan Nadon
docData_INSTALL is defined in 1.9 and 1.10 but not 1.11 Reported-by: Tobias Droste <tdroste@gmx.de> Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2010-02-09doc: use $(mkdir_p) rather than $(MKDIR_P) due to automake 1.9.6Gaetan Nadon
$(MKDIR_P) is not defined in automake 1.9. Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2010-02-04doc: install generated images in $docdirGaetan Nadon
The html installed doc is incomplete without the generated images. Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2010-01-31doc: use new macros to control doc generationGaetan Nadon
Namely XORG_WITH_GROFF for the groff generation tool XORG_ENABLE_DOCS for the generation of all docs Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2010-01-26doc: clean-up generated html imagesGaetan Nadon
Generate images in /images as is the convention Provide a base file name for images rather than process ID Remove images directory when running make clean Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2010-01-14Update Sun license notices to current X.Org standard formAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@sun.com>
2009-11-19Update .gitignore for the /doc directory #24239Gaetan Nadon
2009-10-10Move session management protocol docs from xorg-docs here tooAlan Coopersmith
Since we don't have a smproto package, but ship the protocol headers in this module, might as well keep the protocol docs with the headers Signed-off-by: Alan Coopersmith <alan.coopersmith@sun.com>
2009-10-10Move docs from xorg-docs, use groff to format for installationAlan Coopersmith
Signed-off-by: Alan Coopersmith <alan.coopersmith@sun.com>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-21 18:18:55 +0000