Rev 2410: (Andrew Bennetts) Add a brief Portability section to HACKING, build HACKING.htm from 'make docs'. in file:///home/pqm/archives/thelove/bzr/%2Btrunk/
Canonical.com Patch Queue Manager
pqm at pqm.ubuntu.com
Thu Apr 12 10:32:44 BST 2007
At file:///home/pqm/archives/thelove/bzr/%2Btrunk/
------------------------------------------------------------
revno: 2410
revision-id: pqm at pqm.ubuntu.com-20070412093242-8r2pilxsjtxs46dj
parent: pqm at pqm.ubuntu.com-20070412063453-ogf089v98ktaopbk
parent: andrew.bennetts at canonical.com-20070411104619-f9hdzo9s4p63je91
committer: Canonical.com Patch Queue Manager<pqm at pqm.ubuntu.com>
branch nick: +trunk
timestamp: Thu 2007-04-12 10:32:42 +0100
message:
(Andrew Bennetts) Add a brief Portability section to HACKING, build HACKING.htm from 'make docs'.
modified:
HACKING HACKING-20050805200004-2a5dc975d870f78c
Makefile Makefile-20050805140406-d96e3498bb61c5bb
------------------------------------------------------------
revno: 2405.2.2
merged: andrew.bennetts at canonical.com-20070411104619-f9hdzo9s4p63je91
parent: andrew.bennetts at canonical.com-20070411080906-4mgvcy6focqyhl0a
committer: Andrew Bennetts <andrew.bennetts at canonical.com>
branch nick: HACKING-portability
timestamp: Wed 2007-04-11 20:46:19 +1000
message:
Add a brief section on portability to HACKING.
------------------------------------------------------------
revno: 2405.2.1
merged: andrew.bennetts at canonical.com-20070411080906-4mgvcy6focqyhl0a
parent: pqm at pqm.ubuntu.com-20070411044855-b83c4dc6fd093648
committer: Andrew Bennetts <andrew.bennetts at canonical.com>
branch nick: HACKING-portability
timestamp: Wed 2007-04-11 18:09:06 +1000
message:
Build HACKING.htm from 'make docs'.
=== modified file 'HACKING'
--- a/HACKING 2007-03-22 01:02:07 +0000
+++ b/HACKING 2007-04-11 10:46:19 +0000
@@ -589,6 +589,17 @@
valid characters are generated where possible.
+Portability Tips
+================
+
+The ``bzrlib.osutils`` module has many useful helper functions, including
+some more portable variants of functions in the standard library.
+
+In particular, don't use ``shutil.rmtree`` unless it's acceptable for it
+to fail on Windows if some files are readonly or still open elsewhere.
+Use ``bzrlib.osutils.rmtree`` instead.
+
+
Merge/review process
====================
=== modified file 'Makefile'
--- a/Makefile 2007-01-30 12:45:50 +0000
+++ b/Makefile 2007-04-11 08:09:06 +0000
@@ -52,7 +52,10 @@
pretty_files: $(patsubst doc/%.txt, $(PRETTYDIR)/%.htm, $(txt_files))
-doc/%.htm: doc/%.txt
+doc/HACKING.htm: HACKING
+ python tools/rst2html.py --link-stylesheet --stylesheet=default.css HACKING doc/HACKING.htm
+
+doc/%.htm: doc/%.txt
python tools/rst2html.py --link-stylesheet --stylesheet=default.css doc/$*.txt doc/$*.htm
$(PRETTYDIR)/%.htm: pretty_docs doc/%.txt
@@ -68,7 +71,7 @@
tools/doc_generate/autodoc_rstx.py
python generate_docs.py -o doc/bzr_man.txt rstx
-docs: $(htm_files)
+docs: $(htm_files) doc/HACKING.htm
copy-docs: docs
python tools/win32/ostools.py copytodir $(htm_files) doc/default.css NEWS README win32_bzr.exe/doc
More information about the bazaar-commits
mailing list