From 5b6891acae30f3c73ffb25d54382f83d684cbb3e Mon Sep 17 00:00:00 2001 From: Nicolas Bigaouette Date: Wed, 19 Sep 2012 11:12:37 -0400 Subject: [PATCH] doc:tutorial: fix typos in the attachment examples. MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit 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.txt | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/doc/tutorial.txt b/doc/tutorial.txt index 4b3b84d..10ee49e 100644 --- a/doc/tutorial.txt +++ b/doc/tutorial.txt @@ -163,15 +163,16 @@ an editor automatically (using your environment's ``VISUAL`` or You can also pipe the comment body in on stdin, which is especially useful for binary attachments, etc.:: - $ cat screenshot.png | be comment --content-type image/png bea/28f + $ cat screenshot.png | be comment --content-type image/png bea/28f - Created comment with ID bea/28f/35d It's polite to insert binary attachments under comments that explain -the content and why you're attaching it, so the above should have been +the content and why you're attaching it, so the above should have +been:: $ be comment bea/28f "Whosit dissapears when you mouse-over whatsit." Created comment with ID bea/28f/41d - $ cat screenshot.png | be comment --content-type image/png bea/28f/41d + $ cat screenshot.png | be comment --content-type image/png bea/28f/41d - Created comment with ID bea/28f/35d For more details, see ``be help comment``. -- 2.26.2