document ogsudo behavior that's not described in its man pages

[japaric]

WIP closes #422

[github-actions[bot]]

Number of dependencies and binary size impact report

Metric	main	PR #428	Delta
Direct dependencies	8	8	-
Total dependencies	86	86	-
Binary size	973.2 KiB	973.2 KiB	-
Text size	562.2 KiB	562.2 KiB	-

Dependencies diff

 └─ sudo [v0.1.0-alpha.1]
    ├─ sudo-cli [v0.1.0-alpha.1]
    ├─ sudo-common [v0.1.0-alpha.1]
    |  ├─ libc [v0.2.144]
    |  ├─ sudo-cli [v0.1.0-alpha.1]
    |  ├─ sudo-pam [v0.1.0-alpha.1]
    |  |  ├─ libc [v0.2.144]
    |  |  ├─ sudo-cutils [v0.1.0-alpha.1]
    |  |  |  └─ libc [v0.2.144]
    |  |  └─ sudo-pam-sys [v0.1.0-alpha.1]
    |  |     ├─ libc [v0.2.144]
    |  |     └─ bindgen [v0.63.0]
    |  |        ├─ bitflags [v1.3.2]
    |  |        ├─ cexpr [v0.6.0]
    |  |        |  └─ nom [v7.1.3]
    |  |        |     ├─ memchr [v2.5.0]
    |  |        |     └─ minimal-lexical [v0.2.1]
    |  |        ├─ clang-sys [v1.6.1]
    |  |        |  ├─ glob [v0.3.1]
    |  |        |  ├─ libc [v0.2.144]
    |  |        |  ├─ libloading [v0.7.4]
    |  |        |  |  └─ cfg-if [v1.0.0]
    |  |        |  └─ glob [v0.3.1]
    |  |        ├─ lazy_static [v1.4.0]
    |  |        ├─ lazycell [v1.3.0]
    |  |        ├─ log [v0.4.17]
    |  |        |  └─ cfg-if [v1.0.0]
    |  |        ├─ peeking_take_while [v0.1.2]
    |  |        ├─ proc-macro2 [v1.0.57]
    |  |        |  └─ unicode-ident [v1.0.8]
    |  |        ├─ quote [v1.0.27]
    |  |        |  └─ proc-macro2 [v1.0.57]
    |  |        ├─ regex [v1.8.1]
    |  |        |  └─ regex-syntax [v0.7.1]
    |  |        ├─ rustc-hash [v1.1.0]
    |  |        ├─ shlex [v1.1.0]
    |  |        ├─ syn [v1.0.109]
    |  |        |  ├─ proc-macro2 [v1.0.57]
    |  |        |  ├─ quote [v1.0.27]
    |  |        |  └─ unicode-ident [v1.0.8]
    |  |        └─ which [v4.4.0]
    |  |           ├─ either [v1.8.1]
    |  |           └─ libc [v0.2.144]
    |  └─ sudo-system [v0.1.0-alpha.1]
    |     ├─ libc [v0.2.144]
    |     ├─ signal-hook [v0.3.15]
    |     |  ├─ libc [v0.2.144]
    |     |  └─ signal-hook-registry [v1.4.1]
    |     |     └─ libc [v0.2.144]
    |     ├─ signal-hook-registry [v1.4.1]
    |     ├─ sudo-cutils [v0.1.0-alpha.1]
    |     └─ sudo-log [v0.1.0-alpha.1]
    |        ├─ env_logger [v0.9.3]
    |        |  └─ log [v0.4.17]
    |        |     └─ cfg-if [v1.0.0]
    |        ├─ log [v0.4.17]
    |        └─ syslog [v6.1.0]
    |           ├─ error-chain [v0.12.4]
    |           |  └─ version_check [v0.9.4]
    |           ├─ hostname [v0.3.1]
    |           |  ├─ libc [v0.2.144]
    |           |  └─ match_cfg [v0.1.0]
    |           ├─ libc [v0.2.144]
    |           ├─ log [v0.4.17]
    |           └─ time [v0.3.21]
    |              ├─ itoa [v1.0.6]
    |              ├─ libc [v0.2.144]
    |              ├─ num_threads [v0.1.6]
    |              └─ time-core [v0.1.1]
    ├─ sudo-env [v0.1.0-alpha.1]
    |  ├─ sudo-common [v0.1.0-alpha.1]
    |  ├─ sudo-system [v0.1.0-alpha.1]
    |  └─ sudoers [v0.1.0-alpha.1]
    |     ├─ glob [v0.3.1]
    |     ├─ sudo-defaults [v0.1.0-alpha.1]
    |     ├─ sudo-log [v0.1.0-alpha.1]
    |     └─ sudo-system [v0.1.0-alpha.1]
    ├─ sudo-exec [v0.1.0-alpha.1]
    |  ├─ signal-hook [v0.3.15]
    |  ├─ sudo-common [v0.1.0-alpha.1]
    |  ├─ sudo-log [v0.1.0-alpha.1]
    |  └─ sudo-system [v0.1.0-alpha.1]
    ├─ sudo-log [v0.1.0-alpha.1]
    ├─ sudo-pam [v0.1.0-alpha.1]
    ├─ sudo-system [v0.1.0-alpha.1]
    └─ sudoers [v0.1.0-alpha.1]

[codecov[bot]]

Codecov Report

Patch and project coverage have no change.

Comparison is base (7df8c08) 72.36% compared to head (3605621) 72.36%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #428   +/-   ##
=======================================
  Coverage   72.36%   72.36%           
=======================================
  Files          45       45           
  Lines        5500     5500           
=======================================
  Hits         3980     3980           
  Misses       1520     1520           

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

[squell]

This document is potentially useful for people, but languishing in the PR queue where it is unlikely to be found.

Shall we un-WIP this, rebase it on current main, and merge this as-is and make an issue to remember to complete it at a later point?