Rev 2678: HTML documentation now use files extension *.html (bialix, r=ian) in file:///home/pqm/archives/thelove/bzr/%2Btrunk/
Canonical.com Patch Queue Manager
pqm at pqm.ubuntu.com
Tue Aug 7 20:19:24 BST 2007
At file:///home/pqm/archives/thelove/bzr/%2Btrunk/
------------------------------------------------------------
revno: 2678
revision-id: pqm at pqm.ubuntu.com-20070807191900-kuqpkgh4sq9fczil
parent: pqm at pqm.ubuntu.com-20070807082835-sxq0vmfbvsebps5z
parent: bialix at ukr.net-20070807173524-1y0huvbb1503cfbv
committer: Canonical.com Patch Queue Manager <pqm at pqm.ubuntu.com>
branch nick: +trunk
timestamp: Tue 2007-08-07 20:19:00 +0100
message:
HTML documentation now use files extension *.html (bialix,r=ian)
renamed:
doc/developers/HACKING => doc/developers/HACKING.txt HACKING-20050805200004-2a5dc975d870f78c
modified:
.bzrignore bzrignore-20050311232317-81f7b71efa2db11a
Makefile Makefile-20050805140406-d96e3498bb61c5bb
NEWS NEWS-20050323055033-4e00b5db738777ff
doc/developers/bundles.txt bundles.txt-20070621030528-qkjnugd7iyud6ow3-1
doc/developers/index.txt index.txt-20070508041241-qznziunkg0nffhiw-1
doc/http_smart_server.txt fastcgi.txt-20061005091552-rz8pva0olkxv0sd8-3
doc/index.txt index.txt-20060622101119-tgwtdci8z769bjb9-2
setup.py setup.py-20050314065409-02f8a0a6e3f9bc70
tools/win32/bzr-win32-bdist-postinstall.py bzrwin32bdistpostinstall.py-20060629085133-098bsfj3va8jc0ql-1
tools/win32/bzr.iss.cog bzr.iss.cog-20060622100836-b3yup582rt3y0nvm-5
doc/developers/HACKING.txt HACKING-20050805200004-2a5dc975d870f78c
------------------------------------------------------------
revno: 2666.2.3
merged: bialix at ukr.net-20070807173524-1y0huvbb1503cfbv
parent: bialix at ukr.net-20070807171929-c6jna7ftya3uqylm
committer: Alexander Belchenko <bialix at ukr.net>
branch nick: htm2html
timestamp: Tue 2007-08-07 20:35:24 +0300
message:
fixes after Ian's review
------------------------------------------------------------
revno: 2666.2.2
merged: bialix at ukr.net-20070807171929-c6jna7ftya3uqylm
parent: bialix at ukr.net-20070802102836-45ys1axb2uak8rno
parent: pqm at pqm.ubuntu.com-20070807082835-sxq0vmfbvsebps5z
committer: Alexander Belchenko <bialix at ukr.net>
branch nick: htm2html
timestamp: Tue 2007-08-07 20:19:29 +0300
message:
merge bzr.dev
------------------------------------------------------------
revno: 2666.2.1
merged: bialix at ukr.net-20070802102836-45ys1axb2uak8rno
parent: pqm at pqm.ubuntu.com-20070801171451-en3tds1hzlru2j83
committer: Alexander Belchenko <bialix at ukr.net>
branch nick: htm2html
timestamp: Thu 2007-08-02 13:28:36 +0300
message:
change generated documentation extension from htm to html
=== renamed file 'doc/developers/HACKING' => 'doc/developers/HACKING.txt'
--- a/doc/developers/HACKING 2007-07-27 05:49:24 +0000
+++ b/doc/developers/HACKING.txt 2007-08-07 17:35:24 +0000
@@ -4,9 +4,9 @@
.. contents::
-(The current version of this document is available in the file ``HACKING``
-in the source tree, or at
-http://doc.bazaar-vcs.org/bzr.dev/developers/HACKING.htm)
+(The current version of this document is available in the file
+``doc/developers/HACKING.txt`` in the source tree, or at
+http://doc.bazaar-vcs.org/bzr.dev/developers/HACKING.html)
Getting Started
=== modified file '.bzrignore'
--- a/.bzrignore 2007-07-18 20:42:38 +0000
+++ b/.bzrignore 2007-08-02 10:28:36 +0000
@@ -24,7 +24,7 @@
# Mac droppings
.DS_Store
# win32 installer generated files
-./doc/*.htm
+./doc/*.html
./doc/bzr_man.txt
./py2exe.log
./tools/win32/bzr.iss
@@ -34,7 +34,7 @@
./html_docs
./pretty_docs
./api
-doc/**/*.htm
+doc/**/*.html
doc/developers/performance.png
bzrlib/_dirstate_helpers_c.c
bzrlib/_knit_load_data_c.c
=== modified file 'Makefile'
--- a/Makefile 2007-07-03 17:12:17 +0000
+++ b/Makefile 2007-08-02 10:28:36 +0000
@@ -74,29 +74,26 @@
# translate txt docs to html
doc_dir := doc
txt_files := $(wildcard $(addsuffix /*.txt, $(doc_dir))) doc/bzr_man.txt
-htm_files := $(patsubst %.txt, %.htm, $(txt_files))
+htm_files := $(patsubst %.txt, %.html, $(txt_files))
dev_txt_files := $(wildcard $(addsuffix /*.txt, doc/developers))
-dev_htm_files := $(patsubst %.txt, %.htm, $(dev_txt_files))
+dev_htm_files := $(patsubst %.txt, %.html, $(dev_txt_files))
pretty-html-docs: pretty_files
pretty_docs:
python -c "import os; os.mkdir('$(PRETTYDIR)')"
-pretty_files: $(patsubst doc/%.txt, $(PRETTYDIR)/%.htm, $(txt_files))
-
-doc/developers/%.htm: doc/developers/%.txt
- python tools/rst2html.py --link-stylesheet --stylesheet=../default.css --footnote-references=superscript $< $@
-
-doc/developers/HACKING.htm: doc/developers/HACKING
- python tools/rst2html.py --link-stylesheet --stylesheet=../default.css --footnote-references=superscript $< $@
-
-%.htm: %.txt
+pretty_files: $(patsubst doc/%.txt, $(PRETTYDIR)/%.html, $(txt_files))
+
+doc/developers/%.html: doc/developers/%.txt
+ python tools/rst2html.py --link-stylesheet --stylesheet=../default.css --footnote-references=superscript $< $@
+
+%.html: %.txt
python tools/rst2html.py --link-stylesheet --stylesheet=default.css --footnote-references=superscript $< $@
-$(PRETTYDIR)/%.htm: pretty_docs doc/%.txt
+$(PRETTYDIR)/%.html: pretty_docs doc/%.txt
python tools/rst2prettyhtml.py doc/bazaar-vcs.org.kid doc/$*.txt \
- $(PRETTYDIR)/$*.htm
+ $(PRETTYDIR)/$*.html
MAN_DEPENDENCIES = bzrlib/builtins.py \
bzrlib/bundle/commands.py \
@@ -113,15 +110,14 @@
man1/bzr.1: $(MAN_DEPENDENCIES)
python generate_docs.py -o $@ man
-ALL_DOCS = $(htm_files) $(MAN_PAGES) doc/developers/HACKING.htm $(dev_htm_files) doc/developers/performance.png
+ALL_DOCS = $(htm_files) $(MAN_PAGES) $(dev_htm_files) doc/developers/performance.png
docs: $(ALL_DOCS)
copy-docs: docs
python tools/win32/ostools.py copytodir $(htm_files) \
doc/default.css NEWS README \
win32_bzr.exe/doc
- python tools/win32/ostools.py copytodir doc/developers/HACKING.htm \
- $(dev_htm_files) \
+ python tools/win32/ostools.py copytodir $(dev_htm_files) \
win32_bzr.exe/doc/developers
# clean produced docs
@@ -158,12 +154,10 @@
# clean on win32 all installer-related files and directories
-clean-win32:
+clean-win32: clean-docs
python tools/win32/ostools.py remove build
python tools/win32/ostools.py remove win32_bzr.exe
python tools/win32/ostools.py remove py2exe.log
- python tools/win32/ostools.py remove doc/*.htm
- python tools/win32/ostools.py remove doc/developers/*.htm
python tools/win32/ostools.py remove doc/bzr_man.txt
python tools/win32/ostools.py remove tools/win32/bzr.iss
python tools/win32/ostools.py remove bzr-setup*.exe
=== modified file 'NEWS'
--- a/NEWS 2007-08-07 08:28:35 +0000
+++ b/NEWS 2007-08-07 17:35:24 +0000
@@ -118,6 +118,7 @@
to display by the online help or inclusion in the man page.
(Ian Clatworthy)
+ * HTML documentation now use files extension *.html (Alexander Belchenko)
LIBRARY API BREAKS:
@@ -248,7 +249,7 @@
* Use exact encoding for merge directives. (Adeodato Simó, #120591)
* Fix tempfile permissions error in smart server tar bundling under
- Windows. (Martin_, #119330)
+ Windows. (Martin _, #119330)
* Fix detection of directory entries in the inventory. (James Westby)
@@ -257,7 +258,7 @@
* Issue a CONNECT request when connecting to an https server
via a proxy to enable SSL tunneling.
- (Vincent Ladeuil, #120678)
+ (Vincent Ladeuil, #120678)
* Fix ``bzr log -r`` to support selecting merge revisions, both
individually and as part of revision ranges.
@@ -349,7 +350,7 @@
LIBRARY API BREAKS:
* Testing cleanups -
- ``bzrlib.repository.RepositoryTestProviderAdapter`` has been moved
+ ``bzrlib.repository.RepositoryTestProviderAdapter`` has been moved
to ``bzrlib.tests.repository_implementations``;
``bzrlib.repository.InterRepositoryTestProviderAdapter`` has been moved
to ``bzrlib.tests.interrepository_implementations``;
=== modified file 'doc/developers/bundles.txt'
--- a/doc/developers/bundles.txt 2007-07-04 23:38:26 +0000
+++ b/doc/developers/bundles.txt 2007-08-02 10:28:36 +0000
@@ -43,7 +43,7 @@
================
`Bundle Format 4 spec`_
-.. _Bundle Format 4 spec: bundle-format4.htm
+.. _Bundle Format 4 spec: bundle-format4.html
Future Plans
=== modified file 'doc/developers/index.txt'
--- a/doc/developers/index.txt 2007-07-13 15:05:36 +0000
+++ b/doc/developers/index.txt 2007-08-02 10:28:36 +0000
@@ -9,40 +9,31 @@
Process
=======
-* `General HACKING HOWTO <HACKING.htm>`_
-
- Guide to policies and tools for working on Bazaar itself.
-
-* `Profiling notes <profiling.htm>`_
-
- Instructions on how to profile bzr code and visualize the results.
+* `General HACKING HOWTO <HACKING.html>`_ |--| Guide to policies and tools
+ for working on Bazaar itself.
+
+* `Profiling notes <profiling.html>`_ |--| Instructions on how to profile
+ bzr code and visualize the results.
Plans
=====
-* `Performance roadmap <performance-roadmap.htm>`_
-
- The roadmap for fixing performance in bzr over the next few releases.
+* `Performance roadmap <performance-roadmap.html>`_ |--| The roadmap
+ for fixing performance in bzr over the next few releases.
Specifications
==============
-* `API versioning <api-versioning.htm>`_
-
- bzrlib API versioning.
-
-* `Bundles <bundles.htm>`_
-
- All about bzr bundles.
-
-* `Container format <container-format.htm>`_
-
- Notes on a container format for streaming and storing Bazaar data.
-
-* `Indices <indices.txt>`_
-
- The index facilities available within bzrlib.
-
-* `Repositories <repository.htm>`_
-
- What repositories do and are used for.
+* `API versioning <api-versioning.html>`_ |--| bzrlib API versioning.
+
+* `Bundles <bundles.html>`_ |--| All about bzr bundles.
+
+* `Container format <container-format.html>`_ |--| Notes on a container format
+ for streaming and storing Bazaar data.
+
+* `Indices <indices.html>`_ |--| The index facilities available within bzrlib.
+
+* `Repositories <repository.html>`_ |--| What repositories do and are used for.
+
+
+.. |--| unicode:: U+2014
=== modified file 'doc/http_smart_server.txt'
--- a/doc/http_smart_server.txt 2007-07-13 22:39:36 +0000
+++ b/doc/http_smart_server.txt 2007-08-02 10:28:36 +0000
@@ -11,7 +11,7 @@
For more information on the smart server, and other ways to configure it
see the main `smart server documentation`_.
-.. _smart server documentation: server.htm
+.. _smart server documentation: server.html
Example
=======
=== modified file 'doc/index.txt'
--- a/doc/index.txt 2007-08-06 08:31:43 +0000
+++ b/doc/index.txt 2007-08-07 17:35:24 +0000
@@ -11,54 +11,40 @@
and what is documented on the wiki.
-* `Tutorial <tutorial.htm>`_
- (wiki page: http://bazaar-vcs.org/IntroductionToBzr)
-
- Explains how to use bzr. Loaded with examples.
-
-* `Configuration <configuration.htm>`_
- (wiki page: http://bazaar-vcs.org/ConfiguringBzr)
-
- Information on how to configure Bazaar.
-
-* `Setting up email <setting_up_email.htm>`_
- (wiki page: http://bazaar-vcs.org/BzrSettingEmail)
-
- The various ways that exist to tell Bazaar your email address for
- commits.
-
-* `Conflict handling <conflicts.htm>`_
-
- The various kind of conflicts you may encounter, and how to handle them.
-
-* `Plugins <plugins.htm>`_
- (wiki page: http://bazaar-vcs.org/BzrPlugins)
-
- Information on how to use plugins in Bazaar.
-
-* `Specifying revision <specifying_revisions.htm>`_
- (wiki page: http://bazaar-vcs.org/BzrRevisionSpec)
-
- Description of the subarguments for ``-r`` as used by commands such as
- **bzr log** and **bzr merge**.
-
-* `Using aliases <using_aliases.htm>`_
- (wiki page: http://bazaar-vcs.org/CommandAliases)
-
- How to set up and use command aliases.
-
-* `Running a Bazaar server <server.htm>`_
-
- How to run a server to allow remote access to Bazaar branches.
-
-* `Running a Bazaar HTTP server <http_smart_server.htm>`_
-
- How to run a smart HTTP server to allow remote access to Bazaar branches.
-
-* `Guidelines for modifying bzr <developers/index.htm>`_
-
- Guide to policies and tools for working on Bazaar itself.
+* `Tutorial <tutorial.html>`_ |--| Explains how to use bzr.
+ Loaded with examples.
+
+* `Configuration <configuration.html>`_ |--| Information on how to configure
+ Bazaar.
+
+* `Setting up email <setting_up_email.html>`_ |--| The various ways that exist
+ to tell Bazaar your email address for commits.
+
+* `Conflict handling <conflicts.html>`_ |--| The various kind of conflicts
+ you may encounter, and how to handle them.
+
+* `Plugins <plugins.html>`_ |--| Information on how to use plugins in Bazaar.
+
+* `Specifying revision <specifying_revisions.html>`_ |--| Description
+ of the subarguments for ``-r`` as used by commands such as
+ **bzr log** and **bzr merge**.
+
+* `Using aliases <using_aliases.html>`_ |--| How to set up
+ and use command aliases.
+
+* `Running a Bazaar server <server.html>`_ |--| How to run a server
+ to allow remote access to Bazaar branches.
+
+* `Running a Bazaar HTTP server <http_smart_server.html>`_ |--| How to run
+ a smart HTTP server to allow remote access to Bazaar branches.
+
+* `Guidelines for modifying bzr <developers/index.html>`_ |--| Guide
+ to policies and tools for working on Bazaar itself.
+
This document automatically created based on output of **bzr help**:
-* `Bazaar User Reference <bzr_man.htm>`_
+* `Bazaar User Reference <bzr_man.html>`_
+
+
+.. |--| unicode:: U+2014
=== modified file 'setup.py'
--- a/setup.py 2007-08-01 15:06:30 +0000
+++ b/setup.py 2007-08-02 10:28:36 +0000
@@ -209,8 +209,8 @@
if 'bdist_wininst' in sys.argv:
import glob
# doc files
- docs = glob.glob('doc/*.htm') + ['doc/default.css']
- dev_docs = glob.glob('doc/developers/*.htm')
+ docs = glob.glob('doc/*.html') + ['doc/default.css']
+ dev_docs = glob.glob('doc/developers/*.html')
# python's distutils-based win32 installer
ARGS = {'scripts': ['bzr', 'tools/win32/bzr-win32-bdist-postinstall.py'],
'ext_modules': ext_modules,
@@ -295,7 +295,7 @@
'cmdclass': command_classes,
'ext_modules': ext_modules,
}
-
+
ARGS.update(META_INFO)
ARGS.update(BZRLIB)
ARGS.update(PKG_DATA)
=== modified file 'tools/win32/bzr-win32-bdist-postinstall.py'
--- a/tools/win32/bzr-win32-bdist-postinstall.py 2007-01-30 12:45:50 +0000
+++ b/tools/win32/bzr-win32-bdist-postinstall.py 2007-08-02 10:28:36 +0000
@@ -111,7 +111,7 @@
directory_created(fldr)
# link to documentation
- docs = os.path.join(sys.exec_prefix, 'Doc', 'Bazaar', 'index.htm')
+ docs = os.path.join(sys.exec_prefix, 'Doc', 'Bazaar', 'index.html')
dst = os.path.join(fldr, 'Documentation.lnk')
create_shortcut(docs, 'Bazaar Documentation', dst)
file_created(dst)
=== modified file 'tools/win32/bzr.iss.cog'
--- a/tools/win32/bzr.iss.cog 2007-07-03 17:13:10 +0000
+++ b/tools/win32/bzr.iss.cog 2007-08-02 10:28:36 +0000
@@ -120,7 +120,7 @@
[Icons]
-Name: "{group}\Documentation index"; Filename: "{app}\doc\index.htm"; WorkingDir: "{app}\doc";
+Name: "{group}\Documentation index"; Filename: "{app}\doc\index.html"; WorkingDir: "{app}\doc";
Name: "{group}\Bazaar Home Page"; Filename: "{app}\bazaar.url"; Comment: "http://www.bazaar-vcs.org";
Name: "{group}\Start Bzr in cmd shell"; Filename: "{cmd}"; Parameters: "/K start_bzr.bat"; WorkingDir: "{app}"; IconFilename: "{app}\bzr.exe"; Comment: "Open new Bzr session";
Name: "{group}\Uninstall Bazaar"; Filename: "{uninstallexe}"; IconFileName: "{sys}\shell32.dll"; IconIndex: 101; Comment: "Remove Bzr completely";
More information about the bazaar-commits
mailing list