/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to doc/en/Makefile

  • Committer: Gustav Hartvigsson
  • Date: 2021-01-09 21:36:27 UTC
  • Revision ID: gustav.hartvigsson@gmail.com-20210109213627-h1xwcutzy9m7a99b
Added 'Case Preserving Working Tree Use Cases' from Canonical Wiki

* Addod a page from the Canonical Bazaar wiki
  with information on the scmeatics of case
  perserving filesystems an a case insensitive
  filesystem works.
  
  * Needs re-work, but this will do as it is the
    same inforamoton as what was on the linked
    page in the currint documentation.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/Makefile
 
1
# Makefile for Sphinx documentation
 
2
#
 
3
 
 
4
# You can set these variables from the command line.
 
5
SPHINXOPTS    =
 
6
SPHINXBUILD   = sphinx-build
 
7
PAPER         =
 
8
 
 
9
# Internal variables.
 
10
PAPEROPT_a4     = -D latex_paper_size=a4
 
11
PAPEROPT_letter = -D latex_paper_size=letter
 
12
ALLSPHINXOPTS   = -d _build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
 
13
 
 
14
.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
 
15
 
 
16
help:
 
17
        @echo "Please use \`make <target>' where <target> is one of"
 
18
        @echo "  html      to make standalone HTML files"
 
19
        @echo "  dirhtml   to make HTML files named index.html in directories"
 
20
        @echo "  pickle    to make pickle files"
 
21
        @echo "  json      to make JSON files"
 
22
        @echo "  htmlhelp  to make HTML files and a HTML help project"
 
23
        @echo "  qthelp    to make HTML files and a qthelp project"
 
24
        @echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
 
25
        @echo "  changes   to make an overview of all changed/added/deprecated items"
 
26
        @echo "  linkcheck to check all external links for integrity"
 
27
        @echo "  doctest   to run all doctests embedded in the documentation (if enabled)"
 
28
 
 
29
clean:
 
30
        -rm -rf _build/*
 
31
 
 
32
api:
 
33
        sphinx-apidoc -feM -s txt -o api ../../breezy
 
34
 
 
35
html:
 
36
        $(make_output_dirs)
 
37
        $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) _build/html
 
38
        @echo
 
39
        @echo "Build finished. The HTML pages are in _build/html."
 
40
 
 
41
dirhtml:
 
42
        $(make_output_dirs)
 
43
        $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) _build/dirhtml
 
44
        @echo
 
45
        @echo "Build finished. The HTML pages are in _build/dirhtml."
 
46
 
 
47
pickle:
 
48
        $(make_output_dirs)
 
49
        $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) _build/pickle
 
50
        @echo
 
51
        @echo "Build finished; now you can process the pickle files."
 
52
 
 
53
json:
 
54
        $(make_output_dirs)
 
55
        $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) _build/json
 
56
        @echo
 
57
        @echo "Build finished; now you can process the JSON files."
 
58
 
 
59
htmlhelp:
 
60
        $(make_output_dirs)
 
61
        $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) _build/htmlhelp
 
62
        @echo
 
63
        @echo "Build finished; now you can run HTML Help Workshop with the" \
 
64
              ".hhp project file in _build/htmlhelp."
 
65
 
 
66
qthelp:
 
67
        $(make_output_dirs)
 
68
        $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) _build/qthelp
 
69
        @echo
 
70
        @echo "Build finished; now you can run "qcollectiongenerator" with the" \
 
71
              ".qhcp project file in _build/qthelp, like this:"
 
72
        @echo "# qcollectiongenerator _build/qthelp/Bazaar.qhcp"
 
73
        @echo "To view the help file:"
 
74
        @echo "# assistant -collectionFile _build/qthelp/Bazaar.qhc"
 
75
 
 
76
latex:
 
77
        $(make_output_dirs)
 
78
        $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
 
79
        @echo
 
80
        @echo "Build finished; the LaTeX files are in _build/latex."
 
81
        @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
 
82
              "run these through (pdf)latex."
 
83
 
 
84
changes:
 
85
        $(make_output_dirs)
 
86
        $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) _build/changes
 
87
        @echo
 
88
        @echo "The overview file is in _build/changes."
 
89
 
 
90
linkcheck:
 
91
        $(make_output_dirs)
 
92
        $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) _build/linkcheck
 
93
        @echo
 
94
        @echo "Link check complete; look for any errors in the above output " \
 
95
              "or in _build/linkcheck/output.txt."
 
96
 
 
97
doctest:
 
98
        $(make_output_dirs)
 
99
        $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) _build/doctest
 
100
        @echo "Testing of doctests in the sources finished, look at the " \
 
101
              "results in _build/doctest/output.txt."
 
102
 
 
103
texinfo:
 
104
        $(make_output_dirs)
 
105
        $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) _build/texinfo
 
106
        # Now build the info files using the Makefile provided by Sphinx
 
107
        $(MAKE) -C _build/texinfo
 
108