[MERGE] Add a brief Portability section to HACKING, build HACKING.htm from 'make docs'.

[Andrew Bennetts]

Somewhat related to this morning's discussion about documentation, although I
actually wrote this on the train last night...

This bundle adds a brief section on Portability to HACKING (much more could be
said, but you have to start somewhere).  It also builds doc/HACKING.htm when you
run "make docs", because I found myself wanting to look at the processed HTML to
get a better feel for what's already in HACKING, and where the new section would
best fit.

-Andrew.

-------------- next part --------------
# Bazaar revision bundle v0.9
#
# message:
#   Add a brief section on portability to HACKING.
# committer: Andrew Bennetts <andrew.bennetts at canonical.com>
# date: Wed 2007-04-11 20:46:19.743000031 +1000

=== modified file HACKING
--- HACKING
+++ HACKING
@@ -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 // last-changed:andrew.bennetts at canonical.com-200704
... 11080906-4mgvcy6focqyhl0a
--- Makefile
+++ Makefile
@@ -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

=== modified directory  // last-changed:andrew.bennetts at canonical.com-200704111
... 04619-f9hdzo9s4p63je91
# revision id: andrew.bennetts at canonical.com-20070411104619-f9hdzo9s4p63je91
# sha1: 59b9755d7fdadad65ec674e8b8fdf4d5928c57ac
# inventory sha1: 0e91f0ab0d6eef8b632c1d5e5c1700b749aff520
# parent ids:
#   andrew.bennetts at canonical.com-20070411080906-4mgvcy6focqyhl0a
# base id: pqm at pqm.ubuntu.com-20070411044855-b83c4dc6fd093648
# properties:
#   branch-nick: HACKING-portability

# message:
#   Build HACKING.htm from 'make docs'.
# committer: Andrew Bennetts <andrew.bennetts at canonical.com>
# date: Wed 2007-04-11 18:09:06.575000048 +1000

=== modified file Makefile // encoding:base64
LS0tIE1ha2VmaWxlCisrKyBNYWtlZmlsZQpAQCAtNTIsNyArNTIsMTAgQEAKIAogcHJldHR5X2Zp
bGVzOiAkKHBhdHN1YnN0IGRvYy8lLnR4dCwgJChQUkVUVFlESVIpLyUuaHRtLCAkKHR4dF9maWxl
cykpCiAKLWRvYy8lLmh0bTogZG9jLyUudHh0Citkb2MvSEFDS0lORy5odG06IEhBQ0tJTkcKKwlw
eXRob24gdG9vbHMvcnN0Mmh0bWwucHkgLS1saW5rLXN0eWxlc2hlZXQgLS1zdHlsZXNoZWV0PWRl
ZmF1bHQuY3NzIEhBQ0tJTkcgZG9jL0hBQ0tJTkcuaHRtCisKK2RvYy8lLmh0bTogZG9jLyUudHh0
IAogCXB5dGhvbiB0b29scy9yc3QyaHRtbC5weSAtLWxpbmstc3R5bGVzaGVldCAtLXN0eWxlc2hl
ZXQ9ZGVmYXVsdC5jc3MgZG9jLyQqLnR4dCBkb2MvJCouaHRtCiAKICQoUFJFVFRZRElSKS8lLmh0
bTogcHJldHR5X2RvY3MgZG9jLyUudHh0CkBAIC02OCw3ICs3MSw3IEBACiAJCSB0b29scy9kb2Nf
Z2VuZXJhdGUvYXV0b2RvY19yc3R4LnB5CiAJcHl0aG9uIGdlbmVyYXRlX2RvY3MucHkgLW8gZG9j
L2J6cl9tYW4udHh0IHJzdHgKIAotZG9jczogJChodG1fZmlsZXMpCitkb2NzOiAkKGh0bV9maWxl
cykgZG9jL0hBQ0tJTkcuaHRtCiAKIGNvcHktZG9jczogZG9jcwogCXB5dGhvbiB0b29scy93aW4z
Mi9vc3Rvb2xzLnB5IGNvcHl0b2RpciAkKGh0bV9maWxlcykgZG9jL2RlZmF1bHQuY3NzIE5FV1Mg
UkVBRE1FICB3aW4zMl9ienIuZXhlL2RvYwoK

=== modified directory  // last-changed:andrew.bennetts at canonical.com-200704110
... 80906-4mgvcy6focqyhl0a
# revision id: andrew.bennetts at canonical.com-20070411080906-4mgvcy6focqyhl0a
# sha1: c167699d6bd27bced9718ee1974a73a1617119db
# inventory sha1: 811cfbb8e85be3e11ca3ec0cb00c0d8afc87302d
# parent ids:
#   pqm at pqm.ubuntu.com-20070411044855-b83c4dc6fd093648
# properties:
#   branch-nick: HACKING-portability