/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/BUILD-NOTES

  • Committer: Robert Collins
  • Date: 2009-08-26 03:20:32 UTC
  • mfrom: (4637 +trunk)
  • mto: (4634.6.2 2.0)
  • mto: This revision was merged to the branch mainline in revision 4660.
  • Revision ID: robertc@robertcollins.net-20090826032032-mx5kiog3eihaoy13
Merge and cherrypick outstanding 2.0 relevant patches from bzr.dev: Up to rev
4637, then 4639,4641,4643,4646,4649,4650,4651. (Robert Collins)

Log messages of the incorporated fixes:

revno: 4651 [merge]
  (robertc) Enable commit via record_iter_changes for specific file
        comments. (Robert Collins)

revno: 4650 [merge]
  Fix shelve on windows. (Robert Collins, #305006)

revno: 4649 [merge]
  (robertc) Make iter_changes produce output that is always safe to
        generate inventory deltas of in the same direction as the
        changes. (Robert Collins, #347649)

revno: 4646 [merge]
  (mbp) developer documentation about content filtering

revno: 4643 [merge]
  (mbp) small tweaks to release documentation

revno: 4641 [merge]
  (abentley) Shelve will not remove tree root.

revno: 4639 [merge]
  (andrew) Fix 'Revision ... not present' errors when upgrading stacked
        branches.

revno: 4637 [merge]
  Fix upgrade of branches in repositories.

revno: 4636 [merge]
  (mbp) fix crash formatting CannotBindAddress

revno: 4635 [merge]
  (robertc) Fix many locking errors on windows due to a small bug in
        merge.transform_tree. (Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/BUILD-NOTES
 
1
To build Bazaar's documentation using Sphinx, follow the
 
2
steps below.
 
3
 
 
4
0. Install Sphinx. You'll need Sphinx 0.6 or later. If that
 
5
   version isn't available in your package manager repositories
 
6
   yet, install python-easyinstall and use it to install Sphinx.
 
7
   See http://sphinx.pocoo.org/ for details.
 
8
 
 
9
1. Build the Bazaar docs normally, i.e. in the project root, run:
 
10
 
 
11
   make docs
 
12
 
 
13
2. Tweak the User Guide index page used:
 
14
 
 
15
   cd doc/en/user-guide
 
16
   bzr mv index.txt index-for-1x.txt
 
17
   bzr mv index-for-2x.txt index.txt
 
18
 
 
19
3. Tweak the Release Notes TOC depth:
 
20
 
 
21
   cd ../release-notes
 
22
   vi NEWS.txt  (change depth to 2)
 
23
 
 
24
4. Change to the docs directory and build the site:
 
25
 
 
26
   cd ../..
 
27
   make html
 
28
 
 
29
The generated output site can be found in _build/html.
 
30
 
 
31
Note: All of the above will Just Work soon. For now, we don't
 
32
want to break the existing doc generation until a few issues
 
33
with the Sphinx-generated site are ironed out, e.g. links from
 
34
the User Reference to ../user-guide/index.html#foo no longer
 
35
work when the User Guide is nicely split into topic pages.