Summary: | fix documentation nits picked up by Lintian | ||
---|---|---|---|
Product: | dbus | Reporter: | Simon McVittie <smcv> |
Component: | core | Assignee: | Simon McVittie <smcv> |
Status: | RESOLVED FIXED | QA Contact: | John (J5) Palmieri <johnp> |
Severity: | minor | ||
Priority: | low | CC: | hp |
Version: | 1.5 | Keywords: | patch |
Hardware: | Other | ||
OS: | All | ||
URL: | http://cgit.freedesktop.org/~smcv/dbus/log/?h=doc-trivia-38284 | ||
Whiteboard: | |||
i915 platform: | i915 features: | ||
Bug Depends on: | |||
Bug Blocks: | 36164 | ||
Attachments: |
[PATCH 1/2] Fix spelling/grammatical mistakes detected by Debian's lintian(1)
[PATCH 2/2] man pages: replace all unescaped hyphen/minus characters with \- |
Description
Simon McVittie
2011-06-14 02:24:03 UTC
Created attachment 47929 [details] [review] [PATCH 1/2] Fix spelling/grammatical mistakes detected by Debian's lintian(1) Created attachment 47930 [details] [review] [PATCH 2/2] man pages: replace all unescaped hyphen/minus characters with \- In a man page, "-" officially means a typographical (Unicode) hyphen, which frequently breaks the ability to copy and paste code examples from a man page. "\-" means the ASCII hyphen/minus character. See <http://lintian.debian.org/tags/hyphen-used-as-minus-sign.html> for more details. Rather than trying to distinguish between hyphens, em-dashes and hyphen/minus, I just replaced all ambiguous hyphens with \- by applying this vim command repeatedly until it didn't find anything: %s/\(^\|[^\\]\)-/\1\\-/g Looks good to me. (BTW, I really see no need for a review procedure for this kind of change. Reviewing this is a waste of time) (In reply to comment #3) > Looks good to me. Thanks, this was fixed in 1.5.6. |
Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.