Hey folks,

When you paste a log or backtrace into a Github issue, please put a line of 
three back-quotes before and after it. That tells Github's Markdown 
parser<https://help.github.com/articles/github-flavored-markdown#fenced-code-blocks>
 to treat it as pre-formatted text and ignore any special characters like "_" 
or "*" in it. It also stops it from misinterpreting a Cocoa stack frame index 
(a "#" followed by a number) as a reference to another issue — this is 
particularly awful because it spams links to it all over the low-numbered bugs 
in the project and there's no way to remove them. :(

[Or, if the dump is really long, consider pasting it into a Gist or Pastie or 
whatever and just linking to it.]

Example of doing it right (from this 
issue<https://github.com/couchbase/sync_gateway/issues/241>):
```
19:35:15.805410 HTTP:  #249: POST /db/_bulk_docs
2014/01/16 19:35:15 http: panic serving 127.0.0.1:36089: interface conversion: 
interface is nil, not float64
goroutine 333 [running]:
net/http.func·007()
/usr/local/go/src/pkg/net/http/server.go:1022 +0xac
github.com/couchbaselabs/sync_gateway/db.ParseRevisions<http://github.com/couchbaselabs/sync_gateway/db.ParseRevisions>(0xc201464200,
 0x79cc60, 0xc2005b3cf0, 0xc2005b3ce0)
/home/andrey/couchbase_source/sync_gateway/src/github.com/couchbaselabs/sync_gateway/db/revtree.go:327<http://github.com/couchbaselabs/sync_gateway/db/revtree.go:327>
 +0x1bf
github.com/couchbaselabs/sync_gateway/rest<http://github.com/couchbaselabs/sync_gateway/rest>.(*handler).handleBulkDocs(0xc2013f6de0,
 0xc200b24ce0, 0x0)
```

Without the back-quotes, this text gets messed up — note that some of the "_"s 
were hidden but caused the text after them to go italic:

19:35:15.805410 HTTP: #249: POST /db/bulkdocs
2014/01/16 19:35:15 http: panic serving 127.0.0.1:36089: interface conversion: 
interface is nil, not float64
goroutine 333 [running]:
net/http.func·007()
/usr/local/go/src/pkg/net/http/server.go:1022 +0xac
github.com/couchbaselabs/sync_gateway/db.ParseRevisions<http://github.com/couchbaselabs/sync_gateway/db.ParseRevisions>(0xc201464200,
 0x79cc60, 0xc2005b3cf0, 0xc2005b3ce0)
/home/andrey/couchbase_source/sync_gateway/src/github.com/couchbaselabs/sync_gateway/db/revtree.go:327<http://github.com/couchbaselabs/sync_gateway/db/revtree.go:327>
 +0x1bf
github.com/couchbaselabs/sync_gateway/rest<http://github.com/couchbaselabs/sync_gateway/rest>.(handler).handleBulkDocs(0xc2013f6de0,
 0xc200b24ce0, 0x0)
/home/andrey/couchbase_source/sync_gateway/src/github.com/couchbaselabs/sync_gateway/rest/bulk_api.go:259<http://github.com/couchbaselabs/sync_gateway/rest/bulk_api.go:259>
 +0x8c4
github.com/couchbaselabs/sync_gateway/rest<http://github.com/couchbaselabs/sync_gateway/rest>.(handler).invoke(0xc2013f6de0,
 0x9bd570, 0xc200211240, 0xc201200a10)

With them, the text is correct and everything's nicely formatted in monospace:

19:35:15.805410 HTTP:  #249: POST /db/_bulk_docs
2014/01/16 19:35:15 http: panic serving 127.0.0.1:36089: interface conversion: 
interface is nil, not float64
goroutine 333 [running]:
net/http.func·007()
    /usr/local/go/src/pkg/net/http/server.go:1022 +0xac
github.com/couchbaselabs/sync_gateway/db.ParseRevisions<http://github.com/couchbaselabs/sync_gateway/db.ParseRevisions>(0xc201464200,
 0x79cc60, 0xc2005b3cf0, 0xc2005b3ce0)
    
/home/andrey/couchbase_source/sync_gateway/src/github.com/couchbaselabs/sync_gateway/db/revtree.go:327<http://github.com/couchbaselabs/sync_gateway/db/revtree.go:327>
 +0x1bf
github.com/couchbaselabs/sync_gateway/rest<http://github.com/couchbaselabs/sync_gateway/rest>.(*handler).handleBulkDocs(0xc2013f6de0,
 0xc200b24ce0, 0x0)
    
/home/andrey/couchbase_source/sync_gateway/src/github.com/couchbaselabs/sync_gateway/rest/bulk_api.go:259<http://github.com/couchbaselabs/sync_gateway/rest/bulk_api.go:259>
 +0x8c4
github.com/couchbaselabs/sync_gateway/rest<http://github.com/couchbaselabs/sync_gateway/rest>.(*handler).invoke(0xc2013f6de0,
 0x9bd570, 0xc200211240, 0xc201200a10)

-- 
You received this message because you are subscribed to the Google Groups 
"Couchbase Mobile" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To view this discussion on the web visit 
https://groups.google.com/d/msgid/mobile-couchbase/48A64C3B-D424-42CE-BE86-82688764C8F0%40couchbase.com.
For more options, visit https://groups.google.com/groups/opt_out.

Reply via email to