Closed
Bug 1439411
Opened 6 years ago
Closed 6 years ago
[mozlog] Essential documentation missing from CLI output
Categories
(Testing :: Mozbase, enhancement)
Tracking
(firefox60 fixed)
RESOLVED
FIXED
mozilla60
Tracking | Status | |
---|---|---|
firefox60 | --- | fixed |
People
(Reporter: jugglinmike, Assigned: jugglinmike)
Details
Attachments
(1 file, 3 obsolete files)
3.33 KB,
patch
|
jgraham
:
review+
|
Details | Diff | Splinter Review |
The output formatters provided by mozlog are well-documented in the online help guide, but this information is not available to users in the CLI. The `add_logging_group` method extends the consuming project's command-line interface without referencing mozlog itself. This means consumers may not have a means to discover the additional information, and even in cases where they can infer this connection, there is no indication of the stability of the behavior. Extend the description of the built-in output formatters to explain their origin and reference the relevant documentation.
Assignee | ||
Comment 1•6 years ago
|
||
Attachment #8952201 -
Flags: review?(james)
Assignee | ||
Comment 2•6 years ago
|
||
The previously-submitted patch contained a syntax error. Apologies for the noise
Assignee: nobody → mike
Attachment #8952201 -
Attachment is obsolete: true
Attachment #8952201 -
Flags: review?(james)
Attachment #8952203 -
Flags: review?(james)
Comment 3•6 years ago
|
||
Comment on attachment 8952203 [details] [diff] [review] 0001-mozlog-Document-built-in-CLI-logging-options.patch Review of attachment 8952203 [details] [diff] [review]: ----------------------------------------------------------------- ::: testing/mozbase/mozlog/mozlog/commandline.py @@ +131,5 @@ > group_description = ("Each option represents a possible logging format " > "and takes a filename to write that format to, " > + "or '-' to write to stdout. Some options are " > + "provided by the mozlog utility; see %s " % DOCS_URL + > + "for extended documentation.") I think that group_description = ("Each option represents a possible logging format " "and takes a filename to write that format to, " "or '-' to write to stdout. Some options are " "provided by the mozlog utility; see %s " "for extended documentation." % DOCS_URL) works and looks better
Attachment #8952203 -
Flags: review?(james)
Assignee | ||
Comment 4•6 years ago
|
||
(In reply to James Graham [:jgraham] from comment #3) > I think that > > group_description = ("Each option represents a possible logging format " > "and takes a filename to write that format to, " > "or '-' to write to stdout. Some options are " > "provided by the mozlog utility; see %s " > "for extended documentation." % DOCS_URL) > > works and looks better I agree!
Attachment #8952203 -
Attachment is obsolete: true
Attachment #8952216 -
Flags: review?(james)
Updated•6 years ago
|
Attachment #8952216 -
Flags: review?(james) → review+
Updated•6 years ago
|
Keywords: checkin-needed
Pushed by aciure@mozilla.com: https://hg.mozilla.org/integration/mozilla-inbound/rev/25a1c4b0e2af [mozlog] Document built-in CLI logging options r=jgraham
Keywords: checkin-needed
Comment 6•6 years ago
|
||
Backed out changeset 25a1c4b0e2af (bug 1439411) for linting failure. a= backout on a CLOSED TREE push that caused the failure: https://treeherder.mozilla.org/#/jobs?repo=mozilla-inbound&revision=25a1c4b0e2afc2d2650a59efe81ddc8c981f064f failure: https://treeherder.mozilla.org/#/jobs?repo=mozilla-inbound&filter-resultStatus=testfailed&filter-resultStatus=busted&filter-resultStatus=exception&filter-classifiedState=unclassified&fromchange=bf662dbf4bc7eb0e0ea23b1241809b19cee24ffe&selectedJob=163151436&filter-searchStr=Linting%20opt%20source-test-mozlint-py-flake8%20(f8) https://treeherder.mozilla.org/logviewer.html#?job_id=163151436&repo=mozilla-inbound&lineNumber=229 backout: https://hg.mozilla.org/integration/mozilla-inbound/rev/fe6cdef6373287718150f3b7230e953f8e268ade
Assignee | ||
Comment 7•6 years ago
|
||
Sorry for the lint failure. This patch corrects it:
> $ ./mach lint -l flake8
> ✖ 0 problems (0 errors, 0 warnings)
Attachment #8952216 -
Attachment is obsolete: true
Attachment #8954053 -
Flags: review?(james)
Updated•6 years ago
|
Attachment #8954053 -
Flags: review?(james) → review+
Updated•6 years ago
|
Keywords: checkin-needed
Pushed by archaeopteryx@coole-files.de: https://hg.mozilla.org/integration/mozilla-inbound/rev/99444f1ed75a [mozlog] Document built-in CLI logging options r=jgraham
Keywords: checkin-needed
Comment 9•6 years ago
|
||
bugherder |
https://hg.mozilla.org/mozilla-central/rev/99444f1ed75a
Status: NEW → RESOLVED
Closed: 6 years ago
status-firefox60:
--- → fixed
Resolution: --- → FIXED
Target Milestone: --- → mozilla60
You need to log in
before you can comment on or make changes to this bug.
Description
•