sin/samba-mirror
1
0
Fork 0
mirror of https://github.com/samba-team/samba.git synced 2025-01-03 01:18:10 +03:00
Code

docs-xml: Remove final references to Samba3-HOWTO and Samba3-ByExample

Browse Source 
Signed-off-by: Andrew Bartlett <abartlet@samba.org>
Reviewed-by: David Disseldorp <ddiss@samba.org>
This commit is contained in:
Andrew Bartlett 2020-06-03 12:09:33 +12:00
parent cedd00fdff
commit ccb606c469
6 changed files with 3 additions and 105 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs-xml/.gitignore vendored
View File

@ -1,9 +1,5 @@
Makefile.settings
Samba3-Developers-Guide-attributions.xml
Samba3-HOWTO-attributions.xml
Samba3-HOWTO.d
Samba4-HOWTO.d
Samba4-HOWTO-attributions.xml
autom4te.cache
config.log
config.status
@ -13,7 +9,6 @@ tmp
smbdotconf/parameters.all.xml
*.d
output/manpages
Samba3-ByExample.tex
Samba3-Developers-Guide.tex
xslt/figures/*.pdf
output/*.pdf
@ -29,11 +24,6 @@ output/*.pdf
*.loe
*.lot
*.toc
Samba3-ByExample.pdf
Samba3-Developers-Guide.pdf
Samba3-HOWTO.pdf
Samba3-HOWTO.tex
Samba4-HOWTO.pdf
Samba4-HOWTO.tex
test.pdf
test.tex

33
docs-xml/Makefile
View File

@ -36,20 +36,16 @@ help:
@echo " release - Build the docs needed for a Samba release"
@echo " all - Build all docs that can be build using the utilities found by configure"
@echo " everything - Build all of the above"
@echo " pdf,tex,ps,manpages,txt,pearson,htmlhelp - Build specific output format"
@echo " pdf,tex,ps,manpages,txt,htmlhelp - Build specific output format"
@echo " html - Build multi-file HTML versions"
@echo " html-single - Build single-file HTML versions"
@echo " htmlman - Build HTML version of manpages"
@echo " samples - Extract examples"
$(PDFDIR)/Samba3-ByExample.pdf $(PSDIR)/Samba3-ByExample.ps $(DOCBOOKDIR)/Samba3-ByExample.xml Samba3-ByExample.tex: $(wildcard Samba3-ByExample/*.xml)
$(PDFDIR)/Samba3-HOWTO.pdf $(PSDIR)/Samba3-HOWTO.ps Samba3-HOWTO.tex $(DOCBOOKDIR)/Samba3-HOWTO.xml: $(wildcard Samba3-HOWTO/*.xml) Samba3-HOWTO-attributions.xml
Samba3-HOWTO/manpages.xml: $(MANPAGEDIR)/smb.conf.5.xml
$(PDFDIR)/Samba3-Developers-Guide.pdf $(PSDIR)/Samba3-Developers-Guide.ps $(DOCBOOKDIR)/Samba3-Developers-Guide.xml Samba3-Developers-Guide.tex: $(wildcard Samba3-Developers-Guide/*.xml) Samba3-Developers-Guide-attributions.xml
# Pseudo targets
all:: $(TARGETS)
everything:: manpages pdf html-single html htmlman txt ps fo htmlhelp pearson
everything:: manpages pdf html-single html htmlman txt ps fo htmlhelp
release:: manpages htmlman html pdf
clean::
@echo "Cleaning up..."
@ -74,8 +70,6 @@ tex:: $(addsuffix .tex,$(MAIN_DOCS))
texi:: $(patsubst %,$(TEXINFODIR)/%.texi,$(MAIN_DOCS))
texiinfo:: $(patsubst %,$(TEXINFODIR)/%.info,$(MAIN_DOCS))
manpages:: $(patsubst $(MANPAGEDIR)/%.xml,$(OUTPUTDIR)/manpages/%,$(MANPAGES))
pearson:: $(PEARSONDIR)/Samba3-HOWTO.xml
pearson-verify:: $(PEARSONDIR)/Samba3-HOWTO.report.html
htmlman:: $(patsubst $(MANPAGEDIR)/%.xml,$(HTMLDIR)/manpages/%.html,$(MANPAGES)) $(HTMLDIR)/manpages/index.html
html-single:: $(patsubst %,$(HTMLDIR)/%.html,$(MAIN_DOCS))
html:: $(patsubst %,$(HTMLDIR)/%/index.html,$(MAIN_DOCS)) $(HTMLDIR)/index.html
@ -237,15 +231,6 @@ $(HTMLDIR)/smb.conf/%.html: $(SMBDOTCONFDOC)/%.xml
@mkdir -p $(@D)
$(XSLTPROC) --output $@ xslt/smb.conf-html.xsl $<
# Pearson compatible XML
$(PEARSONDIR)/%.xml: %/index.xml xslt/pearson.xsl
@mkdir -p $(@D)
$(XSLTPROC) --xinclude --output $@ xslt/sambadoc2pearson.xsl $<
$(PEARSONDIR)/%.report.html: $(PEARSONDIR)/%.xml
@mkdir -p $(@D)
-$(XMLLINT) --valid --noout $< 2> $@
# Validation verification
%-validate: %/index.xml
cd $(<D) && $(XMLLINT) --xinclude --noent --postvalid --noout $(<F)
@ -253,17 +238,6 @@ $(PEARSONDIR)/%.report.html: $(PEARSONDIR)/%.xml
build/catalog.xml: build/catalog.xml.in
sed -e "s|@abs_top_srcdir@|`pwd`|g;s|@abs_top_builddir@|`pwd`|g" < build/catalog.xml.in > build/catalog.xml
samples: $(DOCBOOKDIR)/Samba3-HOWTO.xml xslt/extract-examples.xsl scripts/indent-smb.conf.pl
@mkdir -p examples
$(XSLTPROC) --xinclude xslt/extract-examples.xsl $< > /dev/null 2> examples/README
for I in examples/*.conf; do { ./scripts/indent-smb.conf.pl < $$I > $$I.tmp; mv $$I.tmp $$I; } done
# Archiving
archive: pdf
@mkdir -p $(ARCHIVEDIR)
cp $(PDFDIR)/Samba3-HOWTO.pdf $(ARCHIVEDIR)/TOSHARG-$(DATETIME).pdf
cp $(PDFDIR)/Samba3-ByExample.pdf $(ARCHIVEDIR)/S3bE-$(DATETIME).pdf
# XSL scripts
xslt/html.xsl: xslt/html-common.xsl
xslt/html-chunk.xsl: xslt/html-common.xsl
@ -271,7 +245,6 @@ xslt/latex.xsl:
xslt/expand-sambadoc.xsl:
xslt/generate-attributions.xsl:
xslt/man.xsl:
xslt/pearson.xsl:
distclean clobber:: clean
rm -f Makefile.settings config.status config.log
@ -283,4 +256,4 @@ realdistclean:: distclean
# Always keep intermediate files if we can
.SECONDARY:
.PHONY: clean clobber archive release everything all
.PHONY: clean clobber release everything all

1
docs-xml/Makefile.settings.in
View File

@ -22,7 +22,6 @@ DOCBOOKDIR = tmp
PSDIR = $(OUTPUTDIR)
PDFDIR = $(OUTPUTDIR)
HTMLHELPDIR = $(OUTPUTDIR)/htmlhelp
PEARSONDIR = $(OUTPUTDIR)/pearson
TXTDIR = $(OUTPUTDIR)/textdocs
HTMLDIR=$(OUTPUTDIR)/htmldocs
DB2LATEX_ARGS = --stringparam latex.documentclass.book @LATEX_DOCUMENTCLASS_OPTIONS@

5
docs-xml/configure.ac
View File

@ -1,9 +1,6 @@
AC_INIT(xslt/latex.xsl)
LATEX_DOCUMENTCLASS_OPTIONS="letterpaper,11pt,openright,twoside"
AC_ARG_ENABLE(prentice-hall,
[ --enable-prentice-hall Produce Prentice-Hall compatible output],
[ test "$enableval" && LATEX_DOCUMENTCLASS_OPTIONS="letterpaper,10pt,openleft,twoside,ph" ])
AC_SUBST(LATEX_DOCUMENTCLASS_OPTIONS)
DOC_BUILD_DATE=`date '+%d-%m-%Y'`
@ -16,7 +13,6 @@ DOCS_TARGET_REQUIRE_PROGRAM(INKSCAPE, inkscape, PS)
DOCS_TARGET_REQUIRE_PROGRAM(INKSCAPE, inkscape, PDF)
DOCS_TARGET_REQUIRE_PROGRAM(INKSCAPE, inkscape, HTML)
DOCS_TARGET_REQUIRE_PROGRAM(INKSCAPE, inkscape, HTMLHELP)
DOCS_TARGET_REQUIRE_PROGRAM(INKSCAPE, inkscape, PEARSON)
DOCS_TARGET_REQUIRE_PROGRAM(PNGTOPNM, pngtopnm, PS)
DOCS_TARGET_REQUIRE_PROGRAM(PNMTOPS, pnmtops, PS)
@ -36,7 +32,6 @@ DOCS_DEFINE_TARGET(HTML, ALL, [HTML versions], [html])
DOCS_DEFINE_TARGET(HTMLHELP, ALL, [HTML Help versions], [htmlhelp])
DOCS_DEFINE_TARGET(HTMLMAN, ALL, [HTML versions of the manpages], [htmlman])
DOCS_DEFINE_TARGET(MANPAGES, ALL, [manpages], [manpages])
DOCS_DEFINE_TARGET(PEARSON, ALL, [pearson-compatible XML], [pearson])
DOCS_DEFINE_TARGET(VALIDATE, ALL, [validating docbook output], [])
DOCS_DEFINE_TARGET(TEXI, ALL, [TexInfo versions], [texi])
DOCS_DEFINE_TARGET(TEXIINFO, ALL, [TexInfo Info versions], [texiinfo])

8
docs-xml/htmldocs.html
View File

@ -14,14 +14,6 @@
<td valign="top">SAMBA <a href="Samba-Developers-Guide/index.html">Developers</a> Guide</td>
<td valign="top">This book is a collection of documents that might be useful for people developing samba or those interested in doing so. It's nothing more than a collection of documents written by samba developers about the internals of various parts of samba and the SMB protocol. It's still (and will always be) incomplete.</td>
</tr>
<tr>
<td valign="top">Samba-3 by <a href="Samba3-ByExample/index.html">Example</a></td>
<td valign="top">Practical Exercises in Successful Samba Deployment.</td>
</tr>
<tr>
<td valign="top">The Official Samba-3 <a href="Samba3-HOWTO/index.html">HOWTO</a> and Reference Guide</td>
<td valign="top">This book provides example configurations, it documents key aspects of Microsoft Windows networking, provides in-depth insight into the important configuration of Samba-3, and helps to put all of these into a useful framework.</td>
</tr>
<tr>
<td valign="top"><a href="manpages/index.html">Man pages</a></td>
<td valign="top">The Samba man pages in HTML.</td>

51
docs-xml/xslt/extract-examples.xsl
View File

@ -1,51 +0,0 @@
<?xml version='1.0'?>
<!--
Extract examples out of a DocBook/XML file into separate files.
(C) Jelmer Vernooij 2003
Published under the GNU GPLv3 or later
-->
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:exsl="http://exslt.org/common"
xmlns:samba="http://www.samba.org/samba/DTD/samba-doc"
version="1.1"
extension-element-prefixes="exsl">
<xsl:output method="xml"/>
<xsl:template match="example/title"></xsl:template>
<xsl:template match="example/simplelist/title"></xsl:template>
<!-- Parse all varlistentries and extract those of them which are descriptions of smb.conf
parameters. We determine them by existence of <anchor> element inside <term> element.
If <anchor> is there, then its 'id' attribute is translated to lower case and is used
as basis for file name for that parameter.
-->
<xsl:template match="example">
<!-- reconstruct varlistentry - not all of them will go into separate files
and also we must repair the main varlistentry itself.
-->
<xsl:variable name="content">
<xsl:apply-templates/>
</xsl:variable>
<!-- Now put varlistentry into separate file _if_ it has anchor associated with it -->
<xsl:variable name="filename"><xsl:text>examples/</xsl:text><xsl:value-of select="@id"/>.conf</xsl:variable>
<!-- Debug message for an operator, just to show progress of processing :) -->
<xsl:message>
<xsl:text>Writing </xsl:text>
<xsl:value-of select="$filename"/>
<xsl:text> for </xsl:text>
<xsl:value-of select="title"/>
</xsl:message>
<!-- Write finally varlistentry to a separate file -->
<exsl:document href="{$filename}"
method="xml"
encoding="UTF-8"
indent="yes"
omit-xml-declaration="yes">
<xsl:copy-of select="$content"/>
</exsl:document>
</xsl:template>
</xsl:stylesheet>