[llvm-dis][docs] Update the list of options on the file header

[AmrDeveloper]

The current llvm-dis file mention only the help command on the header, should be updated with current available options.

llvm-project/llvm/tools/llvm-dis/llvm-dis.cpp

Lines 8 to 16 in 02c943a

	//
	// This utility may be invoked in the following manner:
	// llvm-dis [options] - Read LLVM bitcode from stdin, write asm to stdout
	// llvm-dis [options] x.bc - Read LLVM bitcode from the x.bc file, write asm
	// to the x.ll file.
	// Options:
	// --help - Output information about command line switches
	//
	//===----------------------------------------------------------------------===//

Current options

llvm-project/llvm/tools/llvm-dis/llvm-dis.cpp

Lines 39 to 85 in 02c943a

	static cl::OptionCategory DisCategory("Disassembler Options");
	static cl::list<std::string> InputFilenames(cl::Positional,
	cl::desc("[input bitcode]..."),
	cl::cat(DisCategory));
	static cl::opt<std::string> OutputFilename("o",
	cl::desc("Override output filename"),
	cl::value_desc("filename"),
	cl::cat(DisCategory));
	static cl::opt<bool> Force("f", cl::desc("Enable binary output on terminals"),
	cl::cat(DisCategory));
	static cl::opt<bool> DontPrint("disable-output",
	cl::desc("Don't output the .ll file"),
	cl::Hidden, cl::cat(DisCategory));
	static cl::opt<bool>
	SetImporting("set-importing",
	cl::desc("Set lazy loading to pretend to import a module"),
	cl::Hidden, cl::cat(DisCategory));
	static cl::opt<bool>
	ShowAnnotations("show-annotations",
	cl::desc("Add informational comments to the .ll file"),
	cl::cat(DisCategory));
	static cl::opt<bool> PreserveAssemblyUseListOrder(
	"preserve-ll-uselistorder",
	cl::desc("Preserve use-list order when writing LLVM assembly."),
	cl::init(false), cl::Hidden, cl::cat(DisCategory));
	static cl::opt<bool>
	MaterializeMetadata("materialize-metadata",
	cl::desc("Load module without materializing metadata, "
	"then materialize only the metadata"),
	cl::cat(DisCategory));
	static cl::opt<bool> PrintThinLTOIndexOnly(
	"print-thinlto-index-only",
	cl::desc("Only read thinlto index and print the index as LLVM assembly."),
	cl::init(false), cl::Hidden, cl::cat(DisCategory));
	extern cl::opt<bool> WriteNewDbgInfoFormat;
	extern cl::opt<cl::boolOrDefault> LoadBitcodeIntoNewDbgInfoFormat;

• Make sure to not add hidden options

[llvmbot]

Hi!

This issue may be a good introductory issue for people new to working on LLVM. If you would like to work on this issue, your first steps are:

1. Check that no other contributor has already been assigned to this issue. If you believe that no one is actually working on it despite an assignment, ping the person. After one week without a response, the assignee may be changed.
2. In the comments of this issue, request for it to be assigned to you, or just create a pull request after following the steps below. Mention this issue in the description of the pull request.
3. Fix the issue locally.
4. Run the test suite locally. Remember that the subdirectories under test/ create fine-grained testing targets, so you can e.g. use make check-clang-ast to only run Clang's AST tests.
5. Create a Git commit.
6. Run git clang-format HEAD~1 to format your changes.
7. Open a pull request to the upstream repository on GitHub. Detailed instructions can be found in GitHub's documentation. Mention this issue in the description of the pull request.

If you have any further questions about this issue, don't hesitate to ask via a comment in the thread below.

[llvmbot]

@llvm/issue-subscribers-good-first-issue

Author: Amr Hesham (AmrDeveloper)

The current llvm-dis file mention only the help command on the header, should be updated with current available options.

llvm-project/llvm/tools/llvm-dis/llvm-dis.cpp

Lines 8 to 16 in 02c943a

	//
	// This utility may be invoked in the following manner:
	// llvm-dis [options] - Read LLVM bitcode from stdin, write asm to stdout
	// llvm-dis [options] x.bc - Read LLVM bitcode from the x.bc file, write asm
	// to the x.ll file.
	// Options:
	// --help - Output information about command line switches
	//
	//===----------------------------------------------------------------------===//

Current options

llvm-project/llvm/tools/llvm-dis/llvm-dis.cpp

Lines 39 to 85 in 02c943a

	static cl::OptionCategory DisCategory("Disassembler Options");
	static cl::list<std::string> InputFilenames(cl::Positional,
	cl::desc("[input bitcode]..."),
	cl::cat(DisCategory));
	static cl::opt<std::string> OutputFilename("o",
	cl::desc("Override output filename"),
	cl::value_desc("filename"),
	cl::cat(DisCategory));
	static cl::opt<bool> Force("f", cl::desc("Enable binary output on terminals"),
	cl::cat(DisCategory));
	static cl::opt<bool> DontPrint("disable-output",
	cl::desc("Don't output the .ll file"),
	cl::Hidden, cl::cat(DisCategory));
	static cl::opt<bool>
	SetImporting("set-importing",
	cl::desc("Set lazy loading to pretend to import a module"),
	cl::Hidden, cl::cat(DisCategory));
	static cl::opt<bool>
	ShowAnnotations("show-annotations",
	cl::desc("Add informational comments to the .ll file"),
	cl::cat(DisCategory));
	static cl::opt<bool> PreserveAssemblyUseListOrder(
	"preserve-ll-uselistorder",
	cl::desc("Preserve use-list order when writing LLVM assembly."),
	cl::init(false), cl::Hidden, cl::cat(DisCategory));
	static cl::opt<bool>
	MaterializeMetadata("materialize-metadata",
	cl::desc("Load module without materializing metadata, "
	"then materialize only the metadata"),
	cl::cat(DisCategory));
	static cl::opt<bool> PrintThinLTOIndexOnly(
	"print-thinlto-index-only",
	cl::desc("Only read thinlto index and print the index as LLVM assembly."),
	cl::init(false), cl::Hidden, cl::cat(DisCategory));
	extern cl::opt<bool> WriteNewDbgInfoFormat;
	extern cl::opt<cl::boolOrDefault> LoadBitcodeIntoNewDbgInfoFormat;

• Make sure to not add hidden options

[txff99]

Hi, I can take a look

[MainakSil]

Hello,

I noticed this issue and would like to help resolve it. May I take this up and submit a pull request to update the header with the current available options?

Thank you!