aboutsummaryrefslogtreecommitdiffstats
path: root/doc/tutorial.txt
Commit message (Collapse)AuthorAgeFilesLines
* doc: update :mod: to :py:mod: for modern Sphinx.W. Trevor King2012-10-261-2/+2
|
* doc:tutorial: fix typos in the attachment examples.Nicolas Bigaouette2012-09-191-3/+4
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | I wrote the actual patch, but Nicolas gave pretty unambiguous directions, so I'm making him the author. On Wed, Sep 19, 2012 at 11:03:39AM -0400, Nicolas Bigaouette wrote: > Hi all, > > I'm trying out Bugs Everywhere, pretty neat! > > Reading the documentation, I see it's possible to add attachment to the bug > report. The "commenting on bugs" section of the tutorial[1] gives the > command for the attachment: > > > $ cat screenshot.png | be comment --content-type image/png bea/28f > > > or the following to reply to a specific comment: > > > $ be comment bea/28f “Whosit dissapears when you mouse-over whatsit.” > > $ cat screenshot.png | be comment --content-type image/png bea/28f/41d > > > > Both these commands fail as they will try to open the editor for entering > the comment. > > The fix is simply to append a single dash "-" at the end of the attachment > command to tell "be comment" to read the comment from stdin (see "be help > comment"). > > Also, the second example has not the same formatting as the first one. The > first one seems to have a "code" formatting, while the second is just > indented without any line breaks. > > Thanks! > > Nicolas > > [1] http://docs.bugseverywhere.org/tutorial.html#commenting-on-bugs
* doc:tutorial: document `be serve-storage`.W. Trevor King2012-08-291-3/+17
|
* Add CherryPy dependency and minimal install info to doc/install.txt.W. Trevor King2012-02-251-0/+3
| | | | | | | | | | | | | | | | I seem to have left CherryPy out of the earlier list. The extra handholding for minimal installations is an attempt to address problems people have had installing BE on non-Linux systems, where the standard build tools are less common. I also mention my Gentoo overlay and Michel Alexandre Salim's Fedora package, so people running Gentoo and Fedora don't have to bother figuring any of this out ;). Finally, I moved the package information up to the top of the install page, so people on supported systems realize they have an easy out before reading through the install procedure.
* Fix links to libbe.util.id from doc/tutorial.txt.W. Trevor King2011-05-111-3/+3
|
* Fix `IDs` and `Mercurial guide` links in docs.W. Trevor King2011-02-231-2/+2
|
* Merge branch 'master' of http://www.physics.drexel.edu/~wking/code/git/beChris Ball2011-01-081-7/+6
|\
| * Cleanup linking from doc/tutorial.txt to email and HTTP docs.W. Trevor King2010-12-061-7/+6
| |
* | Clarify that bugs cannot contain multi-line descriptionsDieter Plaetinck2010-10-311-4/+5
|/
* Updated docs b/c of new Monotone backendW. Trevor King2010-06-261-5/+6
|
* 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
| |
* | Many markup fixes in doc/W. Trevor King2010-06-221-8/+7
|/ | | | | | | | 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.
* Fixed docstrings so only Sphinx errors are "autosummary" and "missing attribute"W. Trevor King2010-02-071-1/+1
|
* Added page titles to the documentation & adjusted section levels.W. Trevor King2010-02-061-75/+26
|
* Created Sphinx framework with sphinx-quickstart and added .txt extensiosnsW. Trevor King2010-02-051-0/+442