aboutsummaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* 'be vXXX' -> 'be XXX' in Sphinx-generated docs to avoid git-hash confusion.W. Trevor King2010-10-221-0/+8
|
* Document command line overrides for built documentation.W. Trevor King2010-10-221-0/+17
|
* Point out that official packages may not be up to date.W. Trevor King2010-10-121-0/+2
|
* Add manpage/DocBook section to doc/doc.txt.W. Trevor King2010-09-281-0/+21
|
* Add dependency section to doc/install.txt.W. Trevor King2010-09-281-0/+32
|
* Wrap `rm` in the RM variable in doc/Makefile.W. Trevor King2010-09-281-1/+2
| | | | This is more consistent with the example set by the root Makefile.
* Converted man page source to DocBook V5.0.W. Trevor King2010-09-282-134/+133
| | | | | | | | This has the dual benefits of keeping up with the current DocBook standard as well as removing the dependency on SGML parsers like docbook-to-man and docbook2man which may not be available on all systems. An XSLT processor and the DocBook style sheets are easier dependencies to satisfy.
* Fixed mnt -> mtn typos in doc/spam.txtThomas Keller2010-06-271-1/+1
|
* Added CFBE invocation notes to doc/http.txt.W. Trevor King2010-06-261-3/+9
| | | | This closes #bea/c72# and its dependent tag #bea/e23#.
* Moved doc/html.txt -> doc/http.txt.W. Trevor King2010-06-262-2/+2
| | | | | `be html` is an HTML interface, but only CFBE (and `be serve`) use HTTP.
* Updated docs b/c of new Monotone backendW. Trevor King2010-06-263-20/+30
|
* Converted Bzr -> Git references in README and doc/*.txtW. Trevor King2010-06-241-8/+8
|
* Ran update_copyright.pyW. Trevor King2010-06-221-1/+16
|
* Merge from Trevor.Chris Ball2010-06-225-43/+47
|\
| * Merged Chris' tutorial BE server URL updateW. Trevor King2010-06-221-4/+4
| |\ | |/ |/|
* | Change location of be --serve'd bugs URL to http://bugs.bugseverywhere.org/Chris Ball2010-06-221-4/+4
| |
* | Merge with TrevorChris Ball2010-06-221-1/+8
|\ \
* \ \ Merge with Trevor.Chris Ball2010-06-2014-43/+1054
|\ \ \
| | | * Many markup fixes in doc/W. Trevor King2010-06-225-43/+47
| | |/ | | | | | | | | | | | | | | | | | | | | | Also added subdir option to generate-libbe-txt.make_module_txt(), in the hopes that subdir='.' would fix the missing reference errors, but no luck (although it did reduce them). I'm sticking with subdir='libbe' for now to avoid cluttering doc/ with autogenerated cruft.
| | * Use Sphinx autosummary (required by numpydoc)wking2010-06-221-1/+2
| | |
| | * Added intersphinx_mapping to doc/conf.py.wking2010-06-221-0/+6
| |/ | | | | | | | | See http://sphinx.pocoo.org/ext/intersphinx.html#confval-intersphinx_mapping
| * Merged initial Sphinx documentation structure.W. Trevor King2010-02-0815-125/+579
| |\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | There's still a long way to go in this direction, but the basic framework is now in place. Toss in numpydoc-style docstrings http://projects.scipy.org/numpy/wiki/CodingStyleGuidelines when you have time, and things will gradually improve over time. I also punted our user ID creation/parsing in libbe.ui.util.user to the email module. This way IDs are handled in an RFC-compliant way (less suprising for users) and by someone else (less work for us :).
| | * Consolidated Makefile and doc/man/module.mk. Incorperated doc/Makefile.W. Trevor King2010-02-082-55/+16
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Now make sphinx builds the Sphinx HTML documentation (in doc/.build/html), and make clean cleans up everything. Having a separate module.mk was just making things confusing, so I took it out ;).
| | * Fixed docstrings so only Sphinx errors are "autosummary" and "missing attribute"W. Trevor King2010-02-074-56/+2
| | |
| | * Use numpydoc and generate-libbe-txt.py to autogenerate API documentationW. Trevor King2010-02-068-40/+82
| | |
| | * Added bugdir and comment modules to Sphinx docsW. Trevor King2010-02-063-0/+16
| | |
| | * Added libbe.bug to the Sphinx documentationW. Trevor King2010-02-065-3/+76
| | |
| | * Broke out install.txt + reStructuredText markup fixesW. Trevor King2010-02-064-100/+130
| | |
| | * Added page titles to the documentation & adjusted section levels.W. Trevor King2010-02-067-86/+123
| | |
| | * Sphynx now gets version string automatically.W. Trevor King2010-02-051-2/+4
| | |
| | * Moved manpage source doc/src to doc/manW. Trevor King2010-02-052-1/+1
| | |
| | * Created Sphinx framework with sphinx-quickstart and added .txt extensiosnsW. Trevor King2010-02-059-0/+303
| |/
| * Encourage a run of `make` to build auto-generated files.W. Trevor King2010-01-271-0/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Fixes Ben's "unintuitive test procedure" bug: Date: Wed, 27 Jan 2010 14:09:14 +1100 From: Ben Finney Subject: [Be-devel] Re: Test suite on Trevor's development branch ... > $ python ./test.py > Traceback (most recent call last): [...] > ImportError: No module named _version So it's not possible to simply get a copy of the branch and try running the test suite. ...
| * Rewrote documentationW. Trevor King2010-01-244-32/+484
| |
| * Reorganized documentation to clean doc/ for user-readable filesW. Trevor King2010-01-234-1/+2
| |
| * Added doc/distributed_bugtracking with some simple use-case notesW. Trevor King2010-01-031-0/+46
| |
| * Updated copyright informationW. Trevor King2010-01-011-1/+1
| |
| * Merged be.restructure, major internal reorganization.W. Trevor King2009-12-312-0/+98
| |\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Added a bunch of classes to make the commands, user interfaces, and storage backends more abstract and distinct. This should make it much easier to extend and maintain BE. Features: * Directory restructured: becommands/ -> libbe/commands submods sorted by functionality. * Lots of new classes: Option, Argument, Command InputOutput, StorageCallbacks, UserInterface Storage * Consolidated ID handling in libbe.util.id * Transitioned VCS backends for Python-based VCSs from subprocess calss to internal python calls. Plus the user-visible changes: * New bugdir/bug/comment ID format replaces old bug:comment format. * Deprecated support for `be diff` on Arch and Darcs <= 2.3.1. A new backend abstraction (Storage) makes the former implementation ungainly. * Improved command completion. * Removed commands close, open, email_bugs, * Flipped some arguments `be assign BUG-ID [ASSIGNEE]` -> `be status ASSIGNED BUG-ID ...` `be severity BUG-ID SEVERITY` -> `be severity SEVERITY BUG-ID ...` `be status BUG-ID STATUS` -> `be status STATUS BUG-ID ...` In the merge: * Added 'commit' to list of pagerless commands. * Updated doc/README.dev See #bea86499-824e-4e77-b085-2d581fa9ccab/1100c966-9671-4bc6-8b68-6d408a910da1# for a discussion of why the changes were made and some of the difficulties en-route.
| | * Emptied interfaces directoryW. Trevor King2009-12-292-0/+130
| |/ | | | | | | | | Mostly throwing out a bunch of outdated GUIs. The email interface hasn't been moved over to the new 'Command' format yet...
| * Ran the new update_copyright.pyW. Trevor King2009-11-191-0/+1
|/
* Updated GPLv2 to current GPLv2.W. Trevor King2009-07-141-3/+15
| | | | | | | | | | | | | | | | | | | | | | | | Fixes Ben's bug 00f26f04-9202-4288-8744-b29abc2342d6. I also tweaked update_copyright.sh to make possible future copyright-blurb revision easier. The new algorithm is greedier, overwriting _all_ consecutive comments after a '^# Copyright' line, so do # Copyright # GPL ... GPL ... GPL # Your comment here... not # Copyright # GPL ... GPL ... GPL # # Your comment here... Without the blank line, your comment would get overwritten by the next run of update_copyright.sh. Note that catmutt is ignored by update_copyright.sh because Moritz Barsnick has only licensed his grepm code under the GPLv2 (not GPLv>=2). See the initial catmutt commit for details.
* Updated copyright blurbs and AUTHORS and included script for future updatesW. Trevor King2009-07-011-1/+1
|
* Updated help strings, man page, and completionsW. Trevor King2009-06-251-116/+3
|
* Apply patches from j@oil21.org, Ben Finney, Jelmer Vernooij.Chris Ball2008-05-162-0/+278