Skip to content
Snippets Groups Projects
  • W. Trevor King's avatar
    39722afa
    irkerd.xml: Cleanup syslog docs and shift 'os' import · 39722afa
    W. Trevor King authored
    This fixes some issues with 672240ab (Use syslog facility when irkerd
    is backgtrounded and no -l was given, 2014-05-31):
    
    * Shift the 'os' import to keep the stdlib imports alphabetized.
    * Move the syslog docs from a stand-alone paragraph into the
      -d/--log-level section.
    * Add some text to the -d/--log-level docs explaining the distinction
      between the -l/--log-file traffic logs and the -d/--log-level
      program-tracing logs.
    * StreamHandler logs to standard error (not standard output) by
      default [1].  Change "stndard output" to "standard error".
    * Add articles to background and foreground ("the background").
    * Fix a "packground" -> "background" typo.
    * Explain our background-detection logic, and point out some of the
      assumptions made by the current implementation.  I still think that
      it's better to have an explicit --syslog setting, and to leave it to
      packagers/users to descide explicitly if they prefer logging to
      syslog or stderr.  But whatever the syslog-switching logic is, it
      should be clearly documented so folks don't have to read the source
      to understand it.
    
    [1]: https://docs.python.org/3/library/logging.handlers.html#logging.StreamHandler
    
    
    
    Signed-off-by: default avatarEric S. Raymond <esr@thyrsus.com>
    39722afa
    History
    irkerd.xml: Cleanup syslog docs and shift 'os' import
    W. Trevor King authored
    This fixes some issues with 672240ab (Use syslog facility when irkerd
    is backgtrounded and no -l was given, 2014-05-31):
    
    * Shift the 'os' import to keep the stdlib imports alphabetized.
    * Move the syslog docs from a stand-alone paragraph into the
      -d/--log-level section.
    * Add some text to the -d/--log-level docs explaining the distinction
      between the -l/--log-file traffic logs and the -d/--log-level
      program-tracing logs.
    * StreamHandler logs to standard error (not standard output) by
      default [1].  Change "stndard output" to "standard error".
    * Add articles to background and foreground ("the background").
    * Fix a "packground" -> "background" typo.
    * Explain our background-detection logic, and point out some of the
      assumptions made by the current implementation.  I still think that
      it's better to have an explicit --syslog setting, and to leave it to
      packagers/users to descide explicitly if they prefer logging to
      syslog or stderr.  But whatever the syslog-switching logic is, it
      should be clearly documented so folks don't have to read the source
      to understand it.
    
    [1]: https://docs.python.org/3/library/logging.handlers.html#logging.StreamHandler
    
    
    
    Signed-off-by: default avatarEric S. Raymond <esr@thyrsus.com>
Code owners
Assign users and groups as approvers for specific file changes. Learn more.