[llvm-bugs] [Bug 39143] New: option descriptions in man page diverges from --help and sometimes from actual behaviour

[via llvm-bugs]

https://bugs.llvm.org/show_bug.cgi?id=39143

            Bug ID: 39143
           Summary: option descriptions in man page diverges from --help
                    and sometimes from actual behaviour
           Product: lld
           Version: unspecified
          Hardware: PC
                OS: All
            Status: NEW
          Severity: normal
          Priority: P
         Component: ELF
          Assignee: unassignedbugs at nondot.org
          Reporter: edd-llvm at mr-edd.co.uk
                CC: llvm-bugs at lists.llvm.org

As of r335947, the content of ELF LLD man page at docs/ld.lld.1 differs from
the --help in a number of places. In a couple of places, the information is
contradictory and the man page does not match actual behaviour.

Problems include but may not be limited to the following. I quickly scanned by
eye.

The following switches don't appear in the man page, but are in the --help:

-(, -), --apply-dynamic-relocs, -Bshareable, -b, --call-graph-ordering-file,
--call_shared, --check-sections, --cref, --dc, --dn, --dp, --dy, -d,
--end-group, --execute-only, -E, -e, --fix-cortex-a53-843419, -F, -f,
--gnu-unique, -h, --icf=safe, --ignore-data-address-equality,
--ignore-function-address-equality, --just-symbols, --keep-unique, --library,
--lto-debug-pass-manager, --lto-new-pass-manager, --lto-sample-profile,
--merge-exidx-entries, --mllvm, -M, -m, --no-allow-multiple-definition,
--no-apply-dynamic-relocs, --no-check-sections, --no-cref, --no-eh-frame-hdr,
--no-execute-only, --no-export-dynamic, --no-fatal-warnings, --no-gdb-index,
--no-merge-exidx-entries, --no-omagic, --no-pic-executable,
--no-print-gc-sections, --no-print-icf-sections, --no-toc-optimize,
--no-use-android-relr-tags, --no-warn-backrefs, --no-warn-common,
--no-warn-symbol-ordering, --non_shared, -N, --orphan-handling, --output,
--pack-dyn-relocs, --pic-executable, --plugin-opt, --plugin,
--print-icf-sections, -q, -R, -r, --start-group, -S, -s, --toc-optimize,
-Ttext-segment, -T, -t, --use-android-relr-tags, -u, --version,
--warn-symbol-ordering, -X, -x, -y, -z.

For --build-id, the man page mentions 'sha1', which isn't a supported value. It
also mentions 'tree', which is handled internally but is not mentioned by
--help.

For --color-diagnostics, the man page says the default is 'auto', whereas
--help says it's 'always'.

Perhaps there's a way to generate the --help and man page from the same source?

-- 
You are receiving this mail because:
You are on the CC list for the bug.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/llvm-bugs/attachments/20181001/c2713552/attachment-0001.html>