llvm / llvm/llvm-project

Use '--output-sort=id' instead of '--output-sort=offset' in the llvm-debuginfo-analyzer documentation.

Open
#180,726 2 comments 0 reactions 0 assignees View on GitHub
documentation tools:llvm-debuginfo-analyzer
Dominant language
LLVM
Stars
40.5k
Forks
18.7k
PR merge metrics
PR metrics pending

Description

The `llvm-debuginfo-analyzer` documentation uses `--output-sort=offset` as the sorting key for the printing of the logical view.
But the internal `offset` used with `--output-sort=offset` is not generated in the same way for all readers, which can produce different output.

https://github.com/llvm/llvm-project/pull/145761 Added the `=none` and `=id` values for the `--output-sort` option.

Replace the use of `--output-sort=offset` with `--output-sort=id`.

Contributor guide

Open the contributing guide

Research direction

Search the llvm-debuginfo-analyzer documentation for `--output-sort=offset` and inspect each occurrence. Replace it with `--output-sort=id`, then review the documentation source to confirm the requested occurrence uses the new key.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.