Rev 3120: Move material out of User Guide into User Reference (Ian Clatworthy) in file:///home/pqm/archives/thelove/bzr/%2Btrunk/
Canonical.com Patch Queue Manager
pqm at pqm.ubuntu.com
Mon Dec 17 06:04:54 GMT 2007
At file:///home/pqm/archives/thelove/bzr/%2Btrunk/
------------------------------------------------------------
revno: 3120
revision-id:pqm at pqm.ubuntu.com-20071217060447-sictlq5nibqhpuec
parent: pqm at pqm.ubuntu.com-20071217034652-jime7u7tuudfvy18
parent: ian.clatworthy at internode.on.net-20071217044920-8fjh9v6m1t93c8dc
committer: Canonical.com Patch Queue Manager <pqm at pqm.ubuntu.com>
branch nick: +trunk
timestamp: Mon 2007-12-17 06:04:47 +0000
message:
Move material out of User Guide into User Reference (Ian Clatworthy)
added:
bzrlib/help_topics/ help_topics-20071211013603-qz0sojhgxhiujm6a-1
bzrlib/help_topics/en/ bzrlibhelp-20071209214431-xzg3moksichjwyts-1
doc/en/user-reference/readme.txt readme.txt-20071211133352-guencaey6fpesv4j-1
renamed:
bzrlib/help_topics.py => bzrlib/help_topics/__init__.py help_topics.py-20060920210027-rnim90q9e0bwxvy4-1
doc/en/user-guide/authentication_conf.txt => bzrlib/help_topics/en/authentication.txt authentication_conf.-20071104135035-glfv0ri355tyg1nf-1
doc/en/user-guide/configuration.txt => bzrlib/help_topics/en/configuration.txt configuration.txt-20060314161707-868350809502af01
doc/en/user-guide/conflicts.txt => bzrlib/help_topics/en/conflicts.txt conflicts.txt-20070723221841-ns3jvwxdb4okn6fk-1
doc/en/user-reference/hooks.txt => bzrlib/help_topics/en/hooks.txt hooks.txt-20070830033044-xxu2rced13f72dka-1
modified:
.bzrignore bzrignore-20050311232317-81f7b71efa2db11a
Makefile Makefile-20050805140406-d96e3498bb61c5bb
NEWS NEWS-20050323055033-4e00b5db738777ff
bzrlib/bugtracker.py bugtracker.py-20070410073305-vu1vu1qosjurg8kb-1
bzrlib/osutils.py osutils.py-20050309040759-eeaff12fbf77ac86
bzrlib/tests/test_help.py test_help.py-20070419045354-6q6rq15j9e2n5fna-1
bzrlib/tests/test_osutils.py test_osutils.py-20051201224856-e48ee24c12182989
doc/en/user-guide/configuring_bazaar.txt configuring_bazaar.t-20071128000722-ncxiua259xwbdbg7-1
doc/en/user-guide/hooks.txt hooks.txt-20070829200551-7nr6e5a1io6x78uf-1
doc/en/user-guide/index.txt index.txt-20060622101119-tgwtdci8z769bjb9-2
doc/en/user-guide/introducing_bazaar.txt introducing_bazaar.t-20071114035000-q36a9h57ps06uvnl-5
doc/en/user-guide/sending_changes.txt sending_changes.txt-20071123154453-dk2mjhrg1vpjm5w2-4
doc/en/user-guide/setting_up_email.txt setting_up_email.txt-20060314161707-fd242c8944346173
setup.py setup.py-20050314065409-02f8a0a6e3f9bc70
tools/doc_generate/autodoc_rstx.py autodoc_rstx.py-20060420024836-3e0d4a526452193c
bzrlib/help_topics/__init__.py help_topics.py-20060920210027-rnim90q9e0bwxvy4-1
bzrlib/help_topics/en/authentication.txt authentication_conf.-20071104135035-glfv0ri355tyg1nf-1
bzrlib/help_topics/en/configuration.txt configuration.txt-20060314161707-868350809502af01
bzrlib/help_topics/en/conflicts.txt conflicts.txt-20070723221841-ns3jvwxdb4okn6fk-1
bzrlib/help_topics/en/hooks.txt hooks.txt-20070830033044-xxu2rced13f72dka-1
------------------------------------------------------------
revno: 3119.1.1
revision-id:ian.clatworthy at internode.on.net-20071217044920-8fjh9v6m1t93c8dc
parent: pqm at pqm.ubuntu.com-20071217034652-jime7u7tuudfvy18
parent: ian.clatworthy at internode.on.net-20071217044541-yrae3mxsh9zfv1ea
committer: Ian Clatworthy <ian.clatworthy at internode.on.net>
branch nick: ianc-integration
timestamp: Mon 2007-12-17 14:49:20 +1000
message:
Move material out of User Guide into User Reference (Ian Clatworthy)
added:
bzrlib/help_topics/ help_topics-20071211013603-qz0sojhgxhiujm6a-1
bzrlib/help_topics/en/ bzrlibhelp-20071209214431-xzg3moksichjwyts-1
doc/en/user-reference/readme.txt readme.txt-20071211133352-guencaey6fpesv4j-1
renamed:
bzrlib/help_topics.py => bzrlib/help_topics/__init__.py help_topics.py-20060920210027-rnim90q9e0bwxvy4-1
doc/en/user-guide/authentication_conf.txt => bzrlib/help_topics/en/authentication.txt authentication_conf.-20071104135035-glfv0ri355tyg1nf-1
doc/en/user-guide/configuration.txt => bzrlib/help_topics/en/configuration.txt configuration.txt-20060314161707-868350809502af01
doc/en/user-guide/conflicts.txt => bzrlib/help_topics/en/conflicts.txt conflicts.txt-20070723221841-ns3jvwxdb4okn6fk-1
doc/en/user-reference/hooks.txt => bzrlib/help_topics/en/hooks.txt hooks.txt-20070830033044-xxu2rced13f72dka-1
modified:
.bzrignore bzrignore-20050311232317-81f7b71efa2db11a
Makefile Makefile-20050805140406-d96e3498bb61c5bb
NEWS NEWS-20050323055033-4e00b5db738777ff
bzrlib/bugtracker.py bugtracker.py-20070410073305-vu1vu1qosjurg8kb-1
bzrlib/osutils.py osutils.py-20050309040759-eeaff12fbf77ac86
bzrlib/tests/test_help.py test_help.py-20070419045354-6q6rq15j9e2n5fna-1
bzrlib/tests/test_osutils.py test_osutils.py-20051201224856-e48ee24c12182989
doc/en/user-guide/configuring_bazaar.txt configuring_bazaar.t-20071128000722-ncxiua259xwbdbg7-1
doc/en/user-guide/hooks.txt hooks.txt-20070829200551-7nr6e5a1io6x78uf-1
doc/en/user-guide/index.txt index.txt-20060622101119-tgwtdci8z769bjb9-2
doc/en/user-guide/introducing_bazaar.txt introducing_bazaar.t-20071114035000-q36a9h57ps06uvnl-5
doc/en/user-guide/sending_changes.txt sending_changes.txt-20071123154453-dk2mjhrg1vpjm5w2-4
doc/en/user-guide/setting_up_email.txt setting_up_email.txt-20060314161707-fd242c8944346173
setup.py setup.py-20050314065409-02f8a0a6e3f9bc70
tools/doc_generate/autodoc_rstx.py autodoc_rstx.py-20060420024836-3e0d4a526452193c
bzrlib/help_topics/__init__.py help_topics.py-20060920210027-rnim90q9e0bwxvy4-1
bzrlib/help_topics/en/authentication.txt authentication_conf.-20071104135035-glfv0ri355tyg1nf-1
bzrlib/help_topics/en/configuration.txt configuration.txt-20060314161707-868350809502af01
bzrlib/help_topics/en/conflicts.txt conflicts.txt-20070723221841-ns3jvwxdb4okn6fk-1
bzrlib/help_topics/en/hooks.txt hooks.txt-20070830033044-xxu2rced13f72dka-1
------------------------------------------------------------
revno: 3089.3.17
revision-id:ian.clatworthy at internode.on.net-20071217044541-yrae3mxsh9zfv1ea
parent: ian.clatworthy at internode.on.net-20071217024440-gb6e5qds0ol0r6sz
committer: Ian Clatworthy <ian.clatworthy at internode.on.net>
branch nick: bzr.ug-tweaks
timestamp: Mon 2007-12-17 14:45:41 +1000
message:
Fix case where filename not given
modified:
tools/doc_generate/autodoc_rstx.py autodoc_rstx.py-20060420024836-3e0d4a526452193c
------------------------------------------------------------
revno: 3089.3.16
revision-id:ian.clatworthy at internode.on.net-20071217024440-gb6e5qds0ol0r6sz
parent: ian.clatworthy at internode.on.net-20071217020045-gogan65avtqjozw5
committer: Ian Clatworthy <ian.clatworthy at internode.on.net>
branch nick: bzr.ug-tweaks
timestamp: Mon 2007-12-17 12:44:40 +1000
message:
Dump help topics into text files in doc/en/user-reference
modified:
.bzrignore bzrignore-20050311232317-81f7b71efa2db11a
NEWS NEWS-20050323055033-4e00b5db738777ff
tools/doc_generate/autodoc_rstx.py autodoc_rstx.py-20060420024836-3e0d4a526452193c
------------------------------------------------------------
revno: 3089.3.15
revision-id:ian.clatworthy at internode.on.net-20071217020045-gogan65avtqjozw5
parent: ian.clatworthy at internode.on.net-20071217014532-dmbv2mm72nzq0ai6
committer: Ian Clatworthy <ian.clatworthy at internode.on.net>
branch nick: bzr.ug-tweaks
timestamp: Mon 2007-12-17 12:00:45 +1000
message:
fix some links
modified:
bzrlib/help_topics/en/hooks.txt hooks.txt-20070830033044-xxu2rced13f72dka-1
doc/en/user-guide/hooks.txt hooks.txt-20070829200551-7nr6e5a1io6x78uf-1
doc/en/user-guide/introducing_bazaar.txt introducing_bazaar.t-20071114035000-q36a9h57ps06uvnl-5
------------------------------------------------------------
revno: 3089.3.14
revision-id:ian.clatworthy at internode.on.net-20071217014532-dmbv2mm72nzq0ai6
parent: ian.clatworthy at internode.on.net-20071217013301-uo5cn2i58g7cwcz6
committer: Ian Clatworthy <ian.clatworthy at internode.on.net>
branch nick: bzr.ug-tweaks
timestamp: Mon 2007-12-17 11:45:32 +1000
message:
follow-up tweaks to bzr.dev integration
modified:
Makefile Makefile-20050805140406-d96e3498bb61c5bb
bzrlib/bugtracker.py bugtracker.py-20070410073305-vu1vu1qosjurg8kb-1
doc/en/user-guide/index.txt index.txt-20060622101119-tgwtdci8z769bjb9-2
doc/en/user-guide/setting_up_email.txt setting_up_email.txt-20060314161707-fd242c8944346173
------------------------------------------------------------
revno: 3089.3.13
revision-id:ian.clatworthy at internode.on.net-20071217013301-uo5cn2i58g7cwcz6
parent: ian.clatworthy at internode.on.net-20071211134018-fciu3eot76z3dpfk
parent: pqm at pqm.ubuntu.com-20071215210020-m28kk1qmbcc9n6qs
committer: Ian Clatworthy <ian.clatworthy at internode.on.net>
branch nick: bzr.ug-tweaks
timestamp: Mon 2007-12-17 11:33:01 +1000
message:
merge bzr.dev
added:
doc/en/user-guide/adv_merging.txt adv_merging.txt-20071213070245-d7u7150lb2hhnvby-1
index.txt index.txt-20071121073725-0corxykv5irjal00-1
modified:
Makefile Makefile-20050805140406-d96e3498bb61c5bb
NEWS NEWS-20050323055033-4e00b5db738777ff
bzr bzr.py-20050313053754-5485f144c7006fa6
bzrlib/__init__.py __init__.py-20050309040759-33e65acf91bbcd5d
bzrlib/branch.py branch.py-20050309040759-e4baf4e0d046576e
bzrlib/bugtracker.py bugtracker.py-20070410073305-vu1vu1qosjurg8kb-1
bzrlib/builtins.py builtins.py-20050830033751-fc01482b9ca23183
bzrlib/errors.py errors.py-20050309040759-20512168c4e14fbd
bzrlib/help_topics/__init__.py help_topics.py-20060920210027-rnim90q9e0bwxvy4-1
bzrlib/help_topics/en/authentication.txt authentication_conf.-20071104135035-glfv0ri355tyg1nf-1
bzrlib/help_topics/en/configuration.txt configuration.txt-20060314161707-868350809502af01
bzrlib/merge_directive.py merge_directive.py-20070228184838-ja62280spt1g7f4x-1
bzrlib/reconfigure.py reconfigure.py-20070908040425-6ykgo7escxhyrg9p-1
bzrlib/repofmt/pack_repo.py pack_repo.py-20070813041115-gjv5ma7ktfqwsjgn-1
bzrlib/tests/HttpServer.py httpserver.py-20061012142527-m1yxdj1xazsf8d7s-1
bzrlib/tests/blackbox/test_bound_branches.py test_bound_branches.py-20051109215527-2373188ad566c205
bzrlib/tests/blackbox/test_commit.py test_commit.py-20060212094538-ae88fc861d969db0
bzrlib/tests/blackbox/test_info.py test_info.py-20060215045507-bbdd2d34efab9e0a
bzrlib/tests/blackbox/test_log.py test_log.py-20060112090212-78f6ea560c868e24
bzrlib/tests/blackbox/test_send.py test_bundle.py-20060616222707-c21c8b7ea5ef57b1
bzrlib/tests/blackbox/test_uncommit.py test_uncommit.py-20051027212835-84944b63adae51be
bzrlib/tests/branch_implementations/test_branch.py testbranch.py-20050711070244-121d632bc37d7253
bzrlib/tests/test_errors.py test_errors.py-20060210110251-41aba2deddf936a8
bzrlib/tests/test_http.py testhttp.py-20051018020158-b2eef6e867c514d9
bzrlib/tests/test_http_response.py test_http_response.py-20060628233143-950b2a482a32505d
bzrlib/tests/test_merge_directive.py test_merge_directive-20070228184838-ja62280spt1g7f4x-2
bzrlib/tests/test_reconfigure.py test_reconfigure.py-20070908040425-6ykgo7escxhyrg9p-2
bzrlib/tests/test_repository.py test_repository.py-20060131075918-65c555b881612f4d
bzrlib/tests/test_revision.py testrevision.py-20050804210559-46f5e1eb67b01289
bzrlib/tests/test_transform.py test_transaction.py-20060105172520-b3ffb3946550e6c4
bzrlib/tests/test_transport.py testtransport.py-20050718175618-e5cdb99f4555ddce
bzrlib/tests/test_transport_implementations.py test_transport_implementations.py-20051227111451-f97c5c7d5c49fce7
bzrlib/transform.py transform.py-20060105172343-dd99e54394d91687
bzrlib/transport/__init__.py transport.py-20050711165921-4978aa7ce1285ad5
bzrlib/transport/http/__init__.py http_transport.py-20050711212304-506c5fd1059ace96
bzrlib/transport/http/_pycurl.py pycurlhttp.py-20060110060940-4e2a705911af77a6
bzrlib/transport/http/_urllib.py _urlgrabber.py-20060113083826-0bbf7d992fbf090c
bzrlib/transport/http/_urllib2_wrappers.py _urllib2_wrappers.py-20060913231729-ha9ugi48ktx481ao-1
bzrlib/transport/http/response.py _response.py-20060613154423-a2ci7hd4iw5c7fnt-1
doc/en/mini-tutorial/index.txt index.txt-20070813141352-2u64ooqzo0or4hss-2
doc/en/user-guide/bug_trackers.txt bug_trackers.txt-20070713223459-khxdlcudraii95uv-1
doc/en/user-guide/core_concepts.txt core_concepts.txt-20071114035000-q36a9h57ps06uvnl-2
doc/en/user-guide/http_smart_server.txt fastcgi.txt-20061005091552-rz8pva0olkxv0sd8-3
doc/en/user-guide/index.txt index.txt-20060622101119-tgwtdci8z769bjb9-2
doc/en/user-guide/installing_bazaar.txt installing_bazaar.tx-20071114035000-q36a9h57ps06uvnl-4
doc/en/user-guide/plugins.txt plugins.txt-20060314145616-525099a747f3ffdd
doc/en/user-guide/publishing_a_branch.txt publishing_a_branch.-20071123055134-k5x4ekduci2lbn36-2
doc/en/user-guide/reusing_a_checkout.txt reusing_a_checkout.t-20071123055134-k5x4ekduci2lbn36-3
doc/en/user-guide/server.txt server.txt-20060913044801-h939fvbwzz39gf7g-1
doc/en/user-guide/setting_up_email.txt setting_up_email.txt-20060314161707-fd242c8944346173
doc/en/user-guide/specifying_revisions.txt specifying_revisions.txt-20060314161707-19deb139101bea33
doc/en/user-guide/version_info.txt version_info.txt-20060921215543-gju6o5xdic8w25np-1
setup.py setup.py-20050314065409-02f8a0a6e3f9bc70
tools/rst2html.py rst2html.py-20060817120932-gn177u8v0008txhu-1
------------------------------------------------------------
revno: 3089.3.12
revision-id:ian.clatworthy at internode.on.net-20071211134018-fciu3eot76z3dpfk
parent: ian.clatworthy at internode.on.net-20071211133432-w81qsxftcxjt2acz
committer: Ian Clatworthy <ian.clatworthy at internode.on.net>
branch nick: bzr.ug-tweaks
timestamp: Tue 2007-12-11 23:40:18 +1000
message:
tweak link to community resources
modified:
doc/en/user-reference/readme.txt readme.txt-20071211133352-guencaey6fpesv4j-1
------------------------------------------------------------
revno: 3089.3.11
revision-id:ian.clatworthy at internode.on.net-20071211133432-w81qsxftcxjt2acz
parent: ian.clatworthy at internode.on.net-20071211132900-is4k97g62rrw0zmj
committer: Ian Clatworthy <ian.clatworthy at internode.on.net>
branch nick: bzr.ug-tweaks
timestamp: Tue 2007-12-11 23:34:32 +1000
message:
add doc/en/user-reference/readme.txt redirecting people to bzrlib/help_topics
added:
doc/en/user-reference/readme.txt readme.txt-20071211133352-guencaey6fpesv4j-1
------------------------------------------------------------
revno: 3089.3.10
revision-id:ian.clatworthy at internode.on.net-20071211132900-is4k97g62rrw0zmj
parent: ian.clatworthy at internode.on.net-20071211064809-lsr11jeg6hjztuzc
committer: Ian Clatworthy <ian.clatworthy at internode.on.net>
branch nick: bzr.ug-tweaks
timestamp: Tue 2007-12-11 23:29:00 +1000
message:
more feedback from Alex - make help_topics a real package
renamed:
bzrlib/help_topics.py => bzrlib/help_topics/__init__.py help_topics.py-20060920210027-rnim90q9e0bwxvy4-1
modified:
bzrlib/help_topics/__init__.py help_topics.py-20060920210027-rnim90q9e0bwxvy4-1
------------------------------------------------------------
revno: 3089.3.9
revision-id:ian.clatworthy at internode.on.net-20071211064809-lsr11jeg6hjztuzc
parent: ian.clatworthy at internode.on.net-20071211061855-6085v1kk7g03ypbk
committer: Ian Clatworthy <ian.clatworthy at internode.on.net>
branch nick: bzr.ug-tweaks
timestamp: Tue 2007-12-11 16:48:09 +1000
message:
add test for resource loading
modified:
bzrlib/tests/test_osutils.py test_osutils.py-20051201224856-e48ee24c12182989
------------------------------------------------------------
revno: 3089.3.8
revision-id:ian.clatworthy at internode.on.net-20071211061855-6085v1kk7g03ypbk
parent: ian.clatworthy at internode.on.net-20071211022107-q24xy5kwheyvzhrt
committer: Ian Clatworthy <ian.clatworthy at internode.on.net>
branch nick: bzr.ug-tweaks
timestamp: Tue 2007-12-11 16:18:55 +1000
message:
move resource loading into a reusable function
modified:
bzrlib/help_topics.py help_topics.py-20060920210027-rnim90q9e0bwxvy4-1
bzrlib/osutils.py osutils.py-20050309040759-eeaff12fbf77ac86
------------------------------------------------------------
revno: 3089.3.7
revision-id:ian.clatworthy at internode.on.net-20071211022107-q24xy5kwheyvzhrt
parent: ian.clatworthy at internode.on.net-20071211020730-sdj4kj794dw0628e
committer: Ian Clatworthy <ian.clatworthy at internode.on.net>
branch nick: bzr.ug-tweaks
timestamp: Tue 2007-12-11 12:21:07 +1000
message:
tweak hooks help to improved readability as suggested by jameinel
modified:
bzrlib/help_topics/en/hooks.txt hooks.txt-20070830033044-xxu2rced13f72dka-1
------------------------------------------------------------
revno: 3089.3.6
revision-id:ian.clatworthy at internode.on.net-20071211020730-sdj4kj794dw0628e
parent: ian.clatworthy at internode.on.net-20071210033111-43kk7y9b3jxog16v
committer: Ian Clatworthy <ian.clatworthy at internode.on.net>
branch nick: bzr.ug-tweaks
timestamp: Tue 2007-12-11 12:07:30 +1000
message:
make help topics more discoverable
added:
bzrlib/help_topics/ help_topics-20071211013603-qz0sojhgxhiujm6a-1
renamed:
bzrlib/help => bzrlib/help_topics/en bzrlibhelp-20071209214431-xzg3moksichjwyts-1
modified:
Makefile Makefile-20050805140406-d96e3498bb61c5bb
bzrlib/help_topics.py help_topics.py-20060920210027-rnim90q9e0bwxvy4-1
setup.py setup.py-20050314065409-02f8a0a6e3f9bc70
------------------------------------------------------------
revno: 3089.3.5
revision-id:ian.clatworthy at internode.on.net-20071210033111-43kk7y9b3jxog16v
parent: ian.clatworthy at internode.on.net-20071210025206-8nikf9hzorca2rmb
committer: Ian Clatworthy <ian.clatworthy at internode.on.net>
branch nick: bzr.ug-tweaks
timestamp: Mon 2007-12-10 13:31:11 +1000
message:
add test for loading help from a file
modified:
bzrlib/tests/test_help.py test_help.py-20070419045354-6q6rq15j9e2n5fna-1
------------------------------------------------------------
revno: 3089.3.4
revision-id:ian.clatworthy at internode.on.net-20071210025206-8nikf9hzorca2rmb
parent: ian.clatworthy at internode.on.net-20071210022530-c9qekaegkjivs6kq
parent: bialix at ukr.net-20071209223510-as4vqqvhlor66jsu
committer: Ian Clatworthy <ian.clatworthy at internode.on.net>
branch nick: bzr.ug-tweaks
timestamp: Mon 2007-12-10 12:52:06 +1000
message:
merge Alex's changes to support Windows installer and use bzrlib/help for topics
added:
bzrlib/help/ bzrlibhelp-20071209214431-xzg3moksichjwyts-1
renamed:
doc/en/user-reference/authentication.txt => bzrlib/help/authentication.txt authentication_conf.-20071104135035-glfv0ri355tyg1nf-1
doc/en/user-reference/configuration.txt => bzrlib/help/configuration.txt configuration.txt-20060314161707-868350809502af01
doc/en/user-reference/conflicts.txt => bzrlib/help/conflicts.txt conflicts.txt-20070723221841-ns3jvwxdb4okn6fk-1
doc/en/user-reference/hooks.txt => bzrlib/help/hooks.txt hooks.txt-20070830033044-xxu2rced13f72dka-1
modified:
Makefile Makefile-20050805140406-d96e3498bb61c5bb
NEWS NEWS-20050323055033-4e00b5db738777ff
bzrlib/help_topics.py help_topics.py-20060920210027-rnim90q9e0bwxvy4-1
doc/en/mini-tutorial/index.txt index.txt-20070813141352-2u64ooqzo0or4hss-2
setup.py setup.py-20050314065409-02f8a0a6e3f9bc70
------------------------------------------------------------
revno: 3087.2.4
revision-id:bialix at ukr.net-20071209223510-as4vqqvhlor66jsu
parent: bialix at ukr.net-20071209213921-8vo4zy555bscz2ze
parent: ian.clatworthy at internode.on.net-20071207033823-vf7u8km1124fwer8
committer: Alexander Belchenko <bialix at ukr.net>
branch nick: docs.tweaks
timestamp: Mon 2007-12-10 00:35:10 +0200
message:
Help topics can now be loaded from files (based on Ian's patch, adapted to proper support various windows installers).
removed:
doc/en/user-reference/index.txt index.txt-20070830033353-ud9e03xsh24053oo-1
added:
bzrlib/help/ bzrlibhelp-20071209214431-xzg3moksichjwyts-1
renamed:
doc/en/user-guide/authentication_conf.txt => bzrlib/help/authentication.txt authentication_conf.-20071104135035-glfv0ri355tyg1nf-1
doc/en/user-guide/configuration.txt => bzrlib/help/configuration.txt configuration.txt-20060314161707-868350809502af01
doc/en/user-guide/conflicts.txt => bzrlib/help/conflicts.txt conflicts.txt-20070723221841-ns3jvwxdb4okn6fk-1
doc/en/user-reference/hooks.txt => bzrlib/help/hooks.txt hooks.txt-20070830033044-xxu2rced13f72dka-1
modified:
Makefile Makefile-20050805140406-d96e3498bb61c5bb
NEWS NEWS-20050323055033-4e00b5db738777ff
bzrlib/help_topics.py help_topics.py-20060920210027-rnim90q9e0bwxvy4-1
doc/en/user-guide/configuring_bazaar.txt configuring_bazaar.t-20071128000722-ncxiua259xwbdbg7-1
doc/en/user-guide/hooks.txt hooks.txt-20070829200551-7nr6e5a1io6x78uf-1
doc/en/user-guide/index.txt index.txt-20060622101119-tgwtdci8z769bjb9-2
doc/en/user-guide/sending_changes.txt sending_changes.txt-20071123154453-dk2mjhrg1vpjm5w2-4
setup.py setup.py-20050314065409-02f8a0a6e3f9bc70
tools/doc_generate/autodoc_rstx.py autodoc_rstx.py-20060420024836-3e0d4a526452193c
bzrlib/help/authentication.txt authentication_conf.-20071104135035-glfv0ri355tyg1nf-1
bzrlib/help/configuration.txt configuration.txt-20060314161707-868350809502af01
bzrlib/help/conflicts.txt conflicts.txt-20070723221841-ns3jvwxdb4okn6fk-1
bzrlib/help/hooks.txt hooks.txt-20070830033044-xxu2rced13f72dka-1
------------------------------------------------------------
revno: 3087.2.3
revision-id:bialix at ukr.net-20071209213921-8vo4zy555bscz2ze
parent: bialix at ukr.net-20071206213948-0dimy7hg2j4n25qy
parent: pqm at pqm.ubuntu.com-20071209175609-xg89vkzd5bcbn2mz
committer: Alexander Belchenko <bialix at ukr.net>
branch nick: docs.tweaks
timestamp: Sun 2007-12-09 23:39:21 +0200
message:
merge bzr.dev
added:
doc/en/quick-reference/quick-start-summary.pdf quickstartsummary.pd-20071207005239-it6xmdjml8nxvzgt-1
modified:
NEWS NEWS-20050323055033-4e00b5db738777ff
README README-20050309040720-8f368abf9f346b9d
bzrlib/branch.py branch.py-20050309040759-e4baf4e0d046576e
bzrlib/builtins.py builtins.py-20050830033751-fc01482b9ca23183
bzrlib/debug.py debug.py-20061102062349-vdhrw9qdpck8cl35-1
bzrlib/diff.py diff.py-20050309040759-26944fbbf2ebbf36
bzrlib/graph.py graph_walker.py-20070525030359-y852guab65d4wtn0-1
bzrlib/help_topics.py help_topics.py-20060920210027-rnim90q9e0bwxvy4-1
bzrlib/merge.py merge.py-20050513021216-953b65a438527106
bzrlib/remote.py remote.py-20060720103555-yeeg2x51vn0rbtdp-1
bzrlib/switch.py switch.py-20071116011000-v5lnw7d2wkng9eux-1
bzrlib/tests/blackbox/test_exceptions.py test_exceptions.py-20060604211237-yi2cxg0ose3xk4id-1
bzrlib/tests/branch_implementations/test_branch.py testbranch.py-20050711070244-121d632bc37d7253
bzrlib/tests/repository_implementations/test_repository.py test_repository.py-20060131092128-ad07f494f5c9d26c
bzrlib/tests/test_diff.py testdiff.py-20050727164403-d1a3496ebb12e339
bzrlib/tests/test_switch.py test_switch.py-20071116011000-v5lnw7d2wkng9eux-2
bzrlib/trace.py trace.py-20050309040759-c8ed824bdcd4748a
doc/index.txt index.txt-20070813101924-07gd9i9d2jt124bf-1
------------------------------------------------------------
revno: 3087.2.2
revision-id:bialix at ukr.net-20071206213948-0dimy7hg2j4n25qy
parent: bialix at ukr.net-20071206213859-ja7697z2aahw74yb
committer: Alexander Belchenko <bialix at ukr.net>
branch nick: docs
timestamp: Thu 2007-12-06 23:39:48 +0200
message:
fix link to user-guide in mini-tutorial
modified:
doc/en/mini-tutorial/index.txt index.txt-20070813141352-2u64ooqzo0or4hss-2
------------------------------------------------------------
revno: 3087.2.1
revision-id:bialix at ukr.net-20071206213859-ja7697z2aahw74yb
parent: pqm at pqm.ubuntu.com-20071206175705-a3go0hme7nx1rr69
parent: bialix at ukr.net-20071206192347-beyt8a6lqcivpbog
committer: Alexander Belchenko <bialix at ukr.net>
branch nick: docs
timestamp: Thu 2007-12-06 23:38:59 +0200
message:
merge other docs improvements
modified:
Makefile Makefile-20050805140406-d96e3498bb61c5bb
bzrlib/help_topics.py help_topics.py-20060920210027-rnim90q9e0bwxvy4-1
------------------------------------------------------------
revno: 3079.1.2
revision-id:bialix at ukr.net-20071206192347-beyt8a6lqcivpbog
parent: bialix at ukr.net-20071205215635-8v0c9xaesck3wfbb
committer: Alexander Belchenko <bialix at ukr.net>
branch nick: criss-cross
timestamp: Thu 2007-12-06 21:23:47 +0200
message:
extend dependecies for bzr_man
modified:
Makefile Makefile-20050805140406-d96e3498bb61c5bb
------------------------------------------------------------
revno: 3089.3.3
revision-id:ian.clatworthy at internode.on.net-20071210022530-c9qekaegkjivs6kq
parent: ian.clatworthy at internode.on.net-20071207033823-vf7u8km1124fwer8
parent: pqm at pqm.ubuntu.com-20071210020804-xbbzol1ndjmec105
committer: Ian Clatworthy <ian.clatworthy at internode.on.net>
branch nick: bzr.ug-tweaks
timestamp: Mon 2007-12-10 12:25:30 +1000
message:
merge bzr.dev
removed:
doc/en/user-reference/index.txt index.txt-20070830033353-ud9e03xsh24053oo-1
modified:
Makefile Makefile-20050805140406-d96e3498bb61c5bb
NEWS NEWS-20050323055033-4e00b5db738777ff
README README-20050309040720-8f368abf9f346b9d
bzrlib/branch.py branch.py-20050309040759-e4baf4e0d046576e
bzrlib/builtins.py builtins.py-20050830033751-fc01482b9ca23183
bzrlib/graph.py graph_walker.py-20070525030359-y852guab65d4wtn0-1
bzrlib/remote.py remote.py-20060720103555-yeeg2x51vn0rbtdp-1
bzrlib/switch.py switch.py-20071116011000-v5lnw7d2wkng9eux-1
bzrlib/tests/blackbox/test_exceptions.py test_exceptions.py-20060604211237-yi2cxg0ose3xk4id-1
bzrlib/tests/branch_implementations/test_branch.py testbranch.py-20050711070244-121d632bc37d7253
bzrlib/tests/repository_implementations/test_repository.py test_repository.py-20060131092128-ad07f494f5c9d26c
bzrlib/tests/test_switch.py test_switch.py-20071116011000-v5lnw7d2wkng9eux-2
bzrlib/trace.py trace.py-20050309040759-c8ed824bdcd4748a
doc/en/quick-reference/quick-start-summary.pdf quickstartsummary.pd-20071207005239-it6xmdjml8nxvzgt-1
------------------------------------------------------------
revno: 3089.3.2
revision-id:ian.clatworthy at internode.on.net-20071207033823-vf7u8km1124fwer8
parent: ian.clatworthy at internode.on.net-20071207033732-14r3w2mlqjn9xj2r
parent: pqm at pqm.ubuntu.com-20071207033029-7tx9ezbg3nlk3io1
committer: Ian Clatworthy <ian.clatworthy at internode.on.net>
branch nick: bzr.ug-tweaks
timestamp: Fri 2007-12-07 13:38:23 +1000
message:
merge bzr.dev
added:
doc/en/quick-reference/quick-start-summary.pdf quickstartsummary.pd-20071207005239-it6xmdjml8nxvzgt-1
modified:
NEWS NEWS-20050323055033-4e00b5db738777ff
bzrlib/help_topics.py help_topics.py-20060920210027-rnim90q9e0bwxvy4-1
doc/index.txt index.txt-20070813101924-07gd9i9d2jt124bf-1
------------------------------------------------------------
revno: 3089.3.1
revision-id:ian.clatworthy at internode.on.net-20071207033732-14r3w2mlqjn9xj2r
parent: pqm at pqm.ubuntu.com-20071206235308-1ol3uk5sbttviy3e
committer: Ian Clatworthy <ian.clatworthy at internode.on.net>
branch nick: bzr.ug-tweaks
timestamp: Fri 2007-12-07 13:37:32 +1000
message:
move reference material out of User Guide into User Reference
renamed:
doc/en/user-guide/authentication_conf.txt => doc/en/user-reference/authentication.txt authentication_conf.-20071104135035-glfv0ri355tyg1nf-1
doc/en/user-guide/configuration.txt => doc/en/user-reference/configuration.txt configuration.txt-20060314161707-868350809502af01
doc/en/user-guide/conflicts.txt => doc/en/user-reference/conflicts.txt conflicts.txt-20070723221841-ns3jvwxdb4okn6fk-1
modified:
NEWS NEWS-20050323055033-4e00b5db738777ff
bzrlib/help_topics.py help_topics.py-20060920210027-rnim90q9e0bwxvy4-1
doc/en/user-guide/configuring_bazaar.txt configuring_bazaar.t-20071128000722-ncxiua259xwbdbg7-1
doc/en/user-guide/hooks.txt hooks.txt-20070829200551-7nr6e5a1io6x78uf-1
doc/en/user-guide/index.txt index.txt-20060622101119-tgwtdci8z769bjb9-2
doc/en/user-guide/sending_changes.txt sending_changes.txt-20071123154453-dk2mjhrg1vpjm5w2-4
doc/en/user-reference/hooks.txt hooks.txt-20070830033044-xxu2rced13f72dka-1
tools/doc_generate/autodoc_rstx.py autodoc_rstx.py-20060420024836-3e0d4a526452193c
doc/en/user-reference/authentication.txt authentication_conf.-20071104135035-glfv0ri355tyg1nf-1
doc/en/user-reference/configuration.txt configuration.txt-20060314161707-868350809502af01
doc/en/user-reference/conflicts.txt conflicts.txt-20070723221841-ns3jvwxdb4okn6fk-1
=== added directory 'bzrlib/help_topics'
=== added directory 'bzrlib/help_topics/en'
=== added file 'doc/en/user-reference/readme.txt'
--- a/doc/en/user-reference/readme.txt 1970-01-01 00:00:00 +0000
+++ b/doc/en/user-reference/readme.txt 2007-12-11 13:40:18 +0000
@@ -0,0 +1,8 @@
+Note: The contents of the User Reference are fully generated from
+Bazaar's online help topics. If you wish to edit this material,
+most of it can be found under bzrlib/help_topics/. In some cases
+though, the material is built by probing various internal
+registries, e.g. the set of available file formats. If you're
+not sure where to find the source content you're looking for,
+please contact the developers on the mailing list or IRC.
+See http://bazaar-vcs.org/BzrSupport for contact details.
=== renamed file 'bzrlib/help_topics.py' => 'bzrlib/help_topics/__init__.py'
--- a/bzrlib/help_topics.py 2007-12-13 13:33:36 +0000
+++ b/bzrlib/help_topics/__init__.py 2007-12-17 01:33:01 +0000
@@ -33,7 +33,13 @@
rendering on the screen naturally.
"""
-from bzrlib import registry
+import sys
+
+import bzrlib
+from bzrlib import (
+ osutils,
+ registry,
+ )
# Section identifiers (map topics to the right place in the manual)
@@ -128,6 +134,15 @@
return ''.join(out)
+def _load_from_file(topic_name):
+ """Load help from a file.
+
+ Topics are expected to be txt files in bzrlib.help_topics.
+ """
+ resource_name = osutils.pathjoin("en", "%s.txt" % (topic_name,))
+ return osutils.resource_string('bzrlib.help_topics', resource_name)
+
+
def _help_on_revisionspec(name):
"""Generate the help for revision specs."""
import re
@@ -608,6 +623,16 @@
topic_registry.register('files', _files,
'Information on configuration and log files')
+# Load some of the help topics from files
+topic_registry.register('authentication', _load_from_file,
+ 'Information on configuring authentication')
+topic_registry.register('configuration', _load_from_file,
+ 'Details on the configuration settings available')
+topic_registry.register('conflicts', _load_from_file,
+ 'Types of conflicts and what to do about them')
+topic_registry.register('hooks', _load_from_file,
+ 'Points at which custom processing can be added')
+
# Register concept topics.
# Note that we might choose to remove these from the online help in the
=== renamed file 'doc/en/user-guide/authentication_conf.txt' => 'bzrlib/help_topics/en/authentication.txt'
--- a/doc/en/user-guide/authentication_conf.txt 2007-12-14 07:35:49 +0000
+++ b/bzrlib/help_topics/en/authentication.txt 2007-12-17 01:33:01 +0000
@@ -1,5 +1,5 @@
-Configuring authentication
-==========================
+Authentication Settings
+=======================
Intent
@@ -112,7 +112,7 @@
The general rules for `configuration files`_ apply except for the variable
policies.
-.. _configuration files: #configuration-reference
+.. _configuration files: #configuration-settings
Each section describes an authentication definition.
=== renamed file 'doc/en/user-guide/configuration.txt' => 'bzrlib/help_topics/en/configuration.txt'
--- a/doc/en/user-guide/configuration.txt 2007-12-14 07:35:49 +0000
+++ b/bzrlib/help_topics/en/configuration.txt 2007-12-17 01:33:01 +0000
@@ -1,11 +1,11 @@
-Configuration reference
+Configuration Settings
=======================
.. TODO: Should have some explanation of why you'd want things in
.. branch.conf.
-Environment variables
+Environment settings
---------------------
While most configuration is handled by configuration files, some options
@@ -222,7 +222,7 @@
variable policies which don't apply.
For more information on the possible uses of the authentication configuration
-file see `Configuring authentication`_.
+file see `Authentication Settings`_.
Common variable options
=== renamed file 'doc/en/user-guide/conflicts.txt' => 'bzrlib/help_topics/en/conflicts.txt'
--- a/doc/en/user-guide/conflicts.txt 2007-11-23 06:06:43 +0000
+++ b/bzrlib/help_topics/en/conflicts.txt 2007-12-09 22:35:10 +0000
@@ -1,4 +1,4 @@
-Conflicts types
+Conflicts Types
===============
Some operations, like merge, revert and pull, modify the contents of your
=== renamed file 'doc/en/user-reference/hooks.txt' => 'bzrlib/help_topics/en/hooks.txt'
--- a/doc/en/user-reference/hooks.txt 2007-11-26 18:43:33 +0000
+++ b/bzrlib/help_topics/en/hooks.txt 2007-12-17 02:00:45 +0000
@@ -1,9 +1,8 @@
-###############
-Hooks Reference
-###############
+Hooks
+=====
post_push
-#########
+---------
Run after ``push`` has completed.
@@ -37,7 +36,8 @@
The revision id (eg joe at foo.com-5676566-boa234a) after the push.
post_pull
-#########
+---------
+
Run after ``pull`` has completed.
The hook signature is (push_result) containing the members
@@ -48,7 +48,8 @@
be the local low-latency branch.
pre_commit
-##########
+----------
+
Run prefore ``commit`` has completed.
The hook signature is (local, master, old_revno, old_revid, future_revno,
@@ -59,14 +60,16 @@
and future_tree.
post_commit
-###########
+-----------
+
Run after ``commit`` has completed.
The hook signature is (local, master, old_revno, old_revid, new_revno,
new_revid) old_revid is NULL_REVISION for the first commit to a branch.
post_uncommit
-#############
+-------------
+
Run after ``uncommit`` has completed.
The api signature is (local, master, old_revno, old_revid, new_revno,
@@ -74,11 +77,14 @@
branch, and an empty branch receives new_revno of 0, new_revid of None.
set_rh
-######
+------
+
Run after the branch's revision history has been modified (push, pull, commit
and uncommit can all modify the revision history).
The hook signature is (branch, revision_history), and the branch will be
write-locked.
-See also `Using Hooks <../user-guide/hooks.html>`_.
+See also `Using hooks`_ in the User Guide.
+
+.. _Using hooks: ../user-guide/index.html#using-hooks
=== modified file '.bzrignore'
--- a/.bzrignore 2007-10-02 02:54:30 +0000
+++ b/.bzrignore 2007-12-17 02:44:40 +0000
@@ -46,3 +46,5 @@
# built extension modules
bzrlib/_*_c.so
bzrlib/_*_c.pyd
+# generated help topics
+doc/en/user-reference/*.txt
=== modified file 'Makefile'
--- a/Makefile 2007-12-15 17:59:00 +0000
+++ b/Makefile 2007-12-17 01:45:32 +0000
@@ -87,7 +87,6 @@
txt_files := $(wildcard $(addsuffix /*.txt, $(doc_dir))) $(derived_txt_files) \
doc/en/user-guide/index.txt \
doc/en/mini-tutorial/index.txt \
- doc/en/user-reference/hooks.txt \
doc/index.txt
non_txt_files := \
doc/default.css \
@@ -114,13 +113,14 @@
MAN_DEPENDENCIES = bzrlib/builtins.py \
bzrlib/bundle/commands.py \
bzrlib/conflicts.py \
- bzrlib/help_topics.py \
+ bzrlib/help_topics/__init__.py \
bzrlib/sign_my_commits.py \
bzrlib/bugtracker.py \
generate_docs.py \
tools/doc_generate/__init__.py \
tools/doc_generate/autodoc_man.py \
- tools/doc_generate/autodoc_rstx.py
+ tools/doc_generate/autodoc_rstx.py \
+ $(wildcard $(addsuffix /*.txt, bzrlib/help_topics/en))
doc/en/user-reference/bzr_man.txt: $(MAN_DEPENDENCIES)
$(PYTHON) generate_docs.py -o $@ rstx
=== modified file 'NEWS'
--- a/NEWS 2007-12-17 00:22:28 +0000
+++ b/NEWS 2007-12-17 04:49:20 +0000
@@ -51,8 +51,20 @@
* ``reconfigure`` is able to convert trees into lightweight checkouts.
(Aaron Bentley)
+ DOCUMENTATION:
+
+ * Reference material has now be moved out of the User Guide and added
+ to the User Reference. The User Reference has gained 4 sections as
+ a result: Authenication Settings, Configuration Settings, Conflicts
+ and Hooks. All help topics are now dumped into text format in the
+ doc/en/user-reference directory for those who like browsing that
+ information in their editor. (Ian Clatworthy)
+
INTERNALS:
+ * Help topics can now be loaded from files.
+ (Ian Clatworthy, Alexander Belchenko)
+
API BREAKS:
TESTING:
=== modified file 'bzrlib/bugtracker.py'
--- a/bzrlib/bugtracker.py 2007-12-13 13:33:36 +0000
+++ b/bzrlib/bugtracker.py 2007-12-17 01:45:32 +0000
@@ -60,7 +60,7 @@
more bugs in one or more trackers at commit time if you wish.
bugzilla_<tracker_abbreviation>_url
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+-----------------------------------
If present, the location of the Bugzilla bug tracker referred to by
<tracker_abbreviation>. This option can then be used together with ``bzr commit
@@ -73,7 +73,7 @@
fixed.
trac_<tracker_abbrevation>_url
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+------------------------------
If present, the location of the Trac instance referred to by
<tracker_abbreviation>. This option can then be used together with ``bzr commit
@@ -86,7 +86,8 @@
fixed.
bugtracker_<tracker_abbrevation>_url
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+------------------------------------
+
If present, the location of a generic bug tracker instance referred to by
<tracker_abbreviation>. The location must contain an ``{id}`` placeholder,
which will be replaced by a specific bug ID. This option can then be used
=== modified file 'bzrlib/osutils.py'
--- a/bzrlib/osutils.py 2007-11-27 20:35:02 +0000
+++ b/bzrlib/osutils.py 2007-12-11 06:18:55 +0000
@@ -1406,6 +1406,7 @@
b += new
return b
+
def dereference_path(path):
"""Determine the real path to a file.
@@ -1423,3 +1424,32 @@
def supports_mapi():
"""Return True if we can use MAPI to launch a mail client."""
return sys.platform == "win32"
+
+
+def resource_string(package, resource_name):
+ """Load a resource from a package and return it as a string.
+
+ Note: Only packages that start with bzrlib are currently supported.
+
+ This is designed to be a lightweight implementation of resource
+ loading in a way which is API compatible with the same API from
+ pkg_resources. See
+ http://peak.telecommunity.com/DevCenter/PkgResources#basic-resource-access.
+ If and when pkg_resources becomes a standard library, this routine
+ can delegate to it.
+ """
+ # Check package name is within bzrlib
+ if package == "bzrlib":
+ resource_relpath = resource_name
+ elif package.startswith("bzrlib."):
+ package = package[len("bzrlib."):].replace('.', os.sep)
+ resource_relpath = pathjoin(package, resource_name)
+ else:
+ raise errors.BzrError('resource package %s not in bzrlib' % package)
+
+ # Map the resource to a file and read its contents
+ base = dirname(bzrlib.__file__)
+ if getattr(sys, 'frozen', None): # bzr.exe
+ base = abspath(pathjoin(base, '..', '..'))
+ filename = pathjoin(base, resource_relpath)
+ return open(filename, 'rU').read()
=== modified file 'bzrlib/tests/test_help.py'
--- a/bzrlib/tests/test_help.py 2007-08-30 13:53:57 +0000
+++ b/bzrlib/tests/test_help.py 2007-12-10 03:31:11 +0000
@@ -201,6 +201,14 @@
'\n'
'See also: bar, foo\n')
+ def test_get_help_text_loaded_from_file(self):
+ # Pick a known topic stored in an external file
+ topic = help_topics.RegisteredTopic('hooks')
+ self.assertStartsWith(topic.get_help_text(),
+ 'Hooks\n'
+ '=====\n'
+ '\n')
+
def test_get_help_topic(self):
"""The help topic for a RegisteredTopic is its topic from construction."""
topic = help_topics.RegisteredTopic('foobar')
=== modified file 'bzrlib/tests/test_osutils.py'
--- a/bzrlib/tests/test_osutils.py 2007-11-12 21:35:15 +0000
+++ b/bzrlib/tests/test_osutils.py 2007-12-11 06:48:09 +0000
@@ -1071,3 +1071,62 @@
self.build_tree_contents([('foo', text)])
expected_sha = osutils.sha_string(text)
self.assertEqual(expected_sha, osutils.sha_file_by_name('foo'))
+
+
+_debug_text = \
+r'''# Copyright (C) 2005, 2006 Canonical Ltd
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+
+
+# NOTE: If update these, please also update the help for global-options in
+# bzrlib/help_topics.py.
+
+debug_flags = set()
+"""Set of flags that enable different debug behaviour.
+
+These are set with eg ``-Dlock`` on the bzr command line.
+
+Options include:
+
+ * auth - show authentication sections used
+ * error - show stack traces for all top level exceptions
+ * evil - capture call sites that do expensive or badly-scaling operations.
+ * fetch - trace history copying between repositories
+ * hooks - trace hook execution
+ * hpss - trace smart protocol requests and responses
+ * http - trace http connections, requests and responses
+ * index - trace major index operations
+ * lock - trace when lockdir locks are taken or released
+ * merge - emit information for debugging merges
+
+"""
+'''
+
+
+class TestResourceLoading(TestCaseInTempDir):
+
+ def test_resource_string(self):
+ # test resource in bzrlib
+ text = osutils.resource_string('bzrlib', 'debug.py')
+ self.assertEquals(_debug_text, text)
+ # test resource under bzrlib
+ text = osutils.resource_string('bzrlib.ui', 'text.py')
+ self.assertContainsRe(text, "class TextUIFactory")
+ # test unsupported package
+ self.assertRaises(errors.BzrError, osutils.resource_string, 'zzzz',
+ 'yyy.xx')
+ # test unknown resource
+ self.assertRaises(IOError, osutils.resource_string, 'bzrlib', 'yyy.xx')
=== modified file 'doc/en/user-guide/configuring_bazaar.txt'
--- a/doc/en/user-guide/configuring_bazaar.txt 2007-11-30 04:28:32 +0000
+++ b/doc/en/user-guide/configuring_bazaar.txt 2007-12-07 03:37:32 +0000
@@ -44,4 +44,5 @@
email = Your Name <email at example.com>
For further details on the syntax and configuration settings supported, see
-`Configuration reference`_ in the appendices.
+`Configuration Settings <../user-reference/bzr_man.html#configuration-settings>`_
+in the Bazaar User Reference.
=== modified file 'doc/en/user-guide/hooks.txt'
--- a/doc/en/user-guide/hooks.txt 2007-11-14 03:50:56 +0000
+++ b/doc/en/user-guide/hooks.txt 2007-12-17 02:00:45 +0000
@@ -11,7 +11,7 @@
Using hooks
-----------
-To use a hook, you should write a `plugin <plugins.html>`_. Instead of
+To use a hook, you should `write a plugin <#writing-a-plugin>`_. Instead of
creating a new command, this plugin will define and install the hook. Here's
an example::
@@ -47,5 +47,5 @@
Standard hooks
--------------
-For a complete list of hooks and their parameters, see the `Hooks Reference
-<../user-reference/hooks.html>`_.
+For a complete list of hooks and their parameters, see `Hooks
+<../user-reference/bzr_man.html#hooks>`_ in the User Reference.
=== modified file 'doc/en/user-guide/index.txt'
--- a/doc/en/user-guide/index.txt 2007-12-14 07:35:49 +0000
+++ b/doc/en/user-guide/index.txt 2007-12-17 01:45:32 +0000
@@ -91,10 +91,7 @@
.. include:: specifying_revisions.txt
.. include:: shared_repository_layouts.txt
-.. include:: conflicts.txt
-.. include:: configuration.txt
.. include:: setting_up_email.txt
-.. include:: authentication_conf.txt
.. include:: http_smart_server.txt
.. include:: writing_a_plugin.txt
=== modified file 'doc/en/user-guide/introducing_bazaar.txt'
--- a/doc/en/user-guide/introducing_bazaar.txt 2007-12-05 05:19:20 +0000
+++ b/doc/en/user-guide/introducing_bazaar.txt 2007-12-17 02:00:45 +0000
@@ -129,7 +129,7 @@
Our collective goal is to build and support a distributed VCS tool that
developers love to use, a tool that helps them get their job done without
getting in their way. If you wish to get involved, please see
-http://bazaar-vcs.org/Community.
+http://bazaar-vcs.org/BzrSupport.
Learning more
=== modified file 'doc/en/user-guide/sending_changes.txt'
--- a/doc/en/user-guide/sending_changes.txt 2007-11-23 15:45:20 +0000
+++ b/doc/en/user-guide/sending_changes.txt 2007-12-07 03:37:32 +0000
@@ -47,8 +47,9 @@
Emailing merge directives is such a common thing that the ``send`` command
without options will create a merge directive, fire up your email
tool and attach it, ready for you to add the explanatory text bit.
-See the online help for ``send`` and the `Configuration reference`_
-for further details on how to configure this.
+See the online help for ``send`` and
+`Configuration Settings <../user-reference/bzr_man.html#configuration-settings>`_
+in the User Reference for further details on how to configure this.
Applying a merge directive
--------------------------
=== modified file 'doc/en/user-guide/setting_up_email.txt'
--- a/doc/en/user-guide/setting_up_email.txt 2007-12-14 07:35:49 +0000
+++ b/doc/en/user-guide/setting_up_email.txt 2007-12-17 01:45:32 +0000
@@ -71,7 +71,10 @@
email=Your Name <name at isp.com>
-For more information on the ini file format, see `Configuration reference`_.
+For more information on the ini file format, see `Configuration Settings`_ in
+the Bazaar User Reference.
+
+.. _Configuration Settings: ../user-reference/bzr_man.html#configuration-settings
Setting email on a per-branch basis
-----------------------------------
=== modified file 'setup.py'
--- a/setup.py 2007-12-15 18:16:06 +0000
+++ b/setup.py 2007-12-17 01:33:01 +0000
@@ -30,6 +30,7 @@
PKG_DATA = {# install files from selftest suite
'package_data': {'bzrlib': ['doc/api/*.txt',
'tests/test_patches_data/*',
+ 'help_topics/en/*.txt',
]},
}
@@ -304,6 +305,10 @@
# so we need to explicitly add all package
additional_packages.append('email')
+ # text files for help topis
+ import glob
+ text_topics = glob.glob('bzrlib/help_topics/en/*.txt')
+
options_list = {"py2exe": {"packages": BZRLIB['packages'] +
additional_packages,
"excludes": ["Tkinter", "medusa", "tools"],
@@ -314,7 +319,9 @@
console=[target,
'tools/win32/bzr_postinstall.py',
],
- zipfile='lib/library.zip')
+ zipfile='lib/library.zip',
+ data_files=[('lib/help_topics/en', text_topics)],
+ )
else:
# ad-hoc for easy_install
=== modified file 'tools/doc_generate/autodoc_rstx.py'
--- a/tools/doc_generate/autodoc_rstx.py 2007-12-13 13:33:36 +0000
+++ b/tools/doc_generate/autodoc_rstx.py 2007-12-17 04:45:41 +0000
@@ -29,6 +29,7 @@
import bzrlib.help
import bzrlib.help_topics
import bzrlib.commands
+import bzrlib.osutils
def get_filename(options):
@@ -46,26 +47,38 @@
"timestamp": time.strftime("%Y-%m-%d %H:%M:%S +0000",tt),
"version": bzrlib.__version__,
}
+ nominated_filename = getattr(options, 'filename', None)
+ if nominated_filename is None:
+ topic_dir = None
+ else:
+ topic_dir = bzrlib.osutils.dirname(nominated_filename)
outfile.write(rstx_preamble % params)
outfile.write(rstx_head % params)
- outfile.write(_get_body(params))
+ outfile.write(_get_body(params, topic_dir))
outfile.write(rstx_foot % params)
-def _get_body(params):
+def _get_body(params, topic_dir):
"""Build the manual content."""
from bzrlib.help_topics import SECT_CONCEPT, SECT_LIST, SECT_PLUGIN
registry = bzrlib.help_topics.topic_registry
result = []
- result.append(_get_section(registry, SECT_CONCEPT, "Concepts"))
- result.append(_get_section(registry, SECT_LIST, "Lists"))
+ result.append(_get_section(registry, SECT_CONCEPT, "Concepts",
+ output_dir=topic_dir))
+ result.append(_get_section(registry, SECT_LIST, "Lists",
+ output_dir=topic_dir))
result.append(_get_commands_section(registry))
- #result.append(_get_section(registry, SECT_PLUGIN, "Core Plug-ins"))
+ #result.append(_get_section(registry, SECT_PLUGIN, "Standard Plug-ins"))
return "\n".join(result)
-def _get_section(registry, section, title, hdg_level1="=", hdg_level2="-"):
- """Build the manual part from topics matching that section."""
+def _get_section(registry, section, title, hdg_level1="#", hdg_level2="=",
+ output_dir=None):
+ """Build the manual part from topics matching that section.
+
+ If output_dir is not None, topics are dumped into text files there
+ during processing, as well as being included in the return result.
+ """
topics = sorted(registry.get_topics_for_section(section))
lines = [title, hdg_level1 * len(title), ""]
@@ -86,12 +99,17 @@
help = registry.get_detail(topic)
heading,text = help.split("\n", 1)
lines.append(heading)
- lines.append(hdg_level2 * len(heading))
+ if not text.startswith(hdg_level2):
+ lines.append(hdg_level2 * len(heading))
lines.append(text)
lines.append('')
# check that topic match heading
if topic != heading.lower():
links_glue.append((topic, heading))
+ # dump the text if requested
+ if output_dir is not None:
+ out_file = bzrlib.osutils.pathjoin(output_dir, topic + ".txt")
+ _dump_text(out_file, help)
# provide links glue for topics that don't match headings
lines.extend([".. _%s: `%s`_" % i for i in links_glue])
@@ -100,8 +118,15 @@
return "\n" + "\n".join(lines) + "\n"
-def _get_commands_section(registry, title="Commands", hdg_level1="=",
- hdg_level2="-"):
+def _dump_text(filename, text):
+ """Dump text to filename."""
+ f = open(filename, "w")
+ f.writelines(text)
+ f.close()
+
+
+def _get_commands_section(registry, title="Commands", hdg_level1="#",
+ hdg_level2="="):
"""Build the comands reference section of the manual."""
lines = [title, hdg_level1 * len(title), ""]
cmds = sorted(bzrlib.commands.builtin_command_names())
@@ -132,9 +157,9 @@
rstx_head = """\
-=====================
+#####################
Bazaar User Reference
-=====================
+#####################
:Version: %(version)s
:Generated: %(datestamp)s
@@ -144,7 +169,7 @@
-----
About This Manual
-=================
+#################
This manual is generated from Bazaar's online help. To use
the online help system, try the following commands.
More information about the bazaar-commits
mailing list