From a83e226c2f28ce7b2a6f9de6740ecc4a72aae8c8 Mon Sep 17 00:00:00 2001 From: Ed Maste Date: Thu, 1 Mar 2018 16:02:19 +0000 Subject: [PATCH] Correct markup and nits in ld.lld man page Patch by Ingo Schwarze llvm-svn: 326446 --- lld/docs/ld.lld.1 | 78 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 40 insertions(+), 38 deletions(-) diff --git a/lld/docs/ld.lld.1 b/lld/docs/ld.lld.1 index 32ff7df..7223461 100644 --- a/lld/docs/ld.lld.1 +++ b/lld/docs/ld.lld.1 @@ -46,7 +46,7 @@ Do not link against shared libraries. Bind defined function symbols locally. .It Fl -Bsymbolic Bind defined symbols locally. -.It Fl -build-id= Ns Ar value +.It Fl -build-id Ns = Ns Ar value Generate a build ID note. .Ar value may be one of @@ -72,8 +72,8 @@ are calculated from the object contents. is not intended to be cryptographically secure. .It Fl -build-id Synonym for -.Fl -build-id= Ns Cm fast . -.It Fl -color-diagnostics= Ns Ar value +.Fl -build-id Ns = Ns Cm fast . +.It Fl -color-diagnostics Ns = Ns Ar value Use colors in diagnostics. .Ar value may be one of @@ -85,8 +85,8 @@ and enables color if and only if output is to a terminal. .It Fl -color-diagnostics Alias for -.Fl -color-diagnostics= Ns Cm auto . -.It Fl -compress-debug-sections= Ns Ar value +.Fl -color-diagnostics Ns = Ns Cm auto . +.It Fl -compress-debug-sections Ns = Ns Ar value Compress DWARF debug sections. .Ar value may be @@ -95,14 +95,14 @@ or .Cm zlib . .It Fl -define-common Assign space to common symbols. -.It Fl -defsym= Ns Ar symbol= Ns Ar expression +.It Fl -defsym Ns = Ns Ar symbol Ns = Ns Ar expression Define a symbol alias. .Ar expression may be another symbol or a linker script expression. For example, -.Fl -defsym= Ns Cm foo= Ns Cm bar +.Ql --defsym=foo=bar or -.Fl -defsym= Ns Cm foo= Ns Cm bar+0x100 . +.Ql --defsym=foo=bar+0x100 . .It Fl -demangle Demangle symbol names. .It Fl -disable-new-dtags @@ -150,13 +150,13 @@ in the dynamic symbol table. Put symbols in the dynamic symbol table. .It Fl -fatal-warnings Treat warnings as errors. -.It Fl -filter= Ns Ar value +.It Fl -filter Ns = Ns Ar value Set the .Dv DT_FILTER field to the specified value. .It Fl -fini Ar symbol Specify a finalizer function. -.It Fl -format= Ns Ar input-format +.It Fl -format Ns = Ns Ar input-format Specify the format of the inputs following this option. .Ar input-format may be one of @@ -184,25 +184,25 @@ or .Cm both is the default. .It Fl -help -Print a usage message. -.It Fl -icf=all +Print a help message. +.It Fl -icf Ns = Ns Cm all Enable identical code folding. -.It Fl -icf=none +.It Fl -icf Ns = Ns Cm none Disable identical code folding. -.It Fl -image-base= Ns Ar value +.It Fl -image-base Ns = Ns Ar value Set the base address to .Ar value . .It Fl -init Ar symbol Specify an initializer function. -.It Fl -lto-aa-pipeline= Ns Ar value +.It Fl -lto-aa-pipeline Ns = Ns Ar value AA pipeline to run during LTO. Used in conjunction with .Fl -lto-newpm-passes . -.It Fl -lto-newpm-passes= Ns Ar value +.It Fl -lto-newpm-passes Ns = Ns Ar value Passes to run during LTO. .It Fl -lto-O Ar opt-level Optimization level for LTO. -.It Fl -lto-partitions= Ns Ar value +.It Fl -lto-partitions Ns = Ns Ar value Number of LTO codegen partitions. .It Fl L Ar dir Add a directory to the library search path. @@ -261,19 +261,21 @@ Write optimization remarks in YAML format to .Ar file . .It Fl -opt-remarks-with-hotness Include hotness information in the optimization remarks file. -.It Fl O Ar value +.It Fl O Ns Ar value Optimize output file size. .Ar value may be: -.Bl -tag -width indent -.It Cm O0 +.Pp +.Bl -tag -width 2n -compact +.It Cm 0 Disable string merging. -.It Cm O1 +.It Cm 1 Enable string merging. -.It Cm O2 +.It Cm 2 Enable string tail merging. .El -.Cm O1 +.Pp +.Fl O Ns Cm 1 is the default. .It Fl o Ar path Write the output executable, library, or object to @@ -291,18 +293,18 @@ Print a link map to the standard output. Create relocatable object file. .It Fl -reproduce Ar value Dump linker invocation and input files for debugging. -.It Fl -retain-symbols-file= Ns Ar file +.It Fl -retain-symbols-file Ns = Ns Ar file Retain only the symbols listed in the file. .It Fl -rpath Ar value Add a .Dv DT_RUNPATH to the output. -.It Fl -rsp-quoting= Ns Ar value +.It Fl -rsp-quoting Ns = Ns Ar value Quoting style for response files. The supported values are -.Ar windows +.Cm windows and -.Ar posix . +.Cm posix . .It Fl -script Ar file Read linker script from .Ar file . @@ -310,7 +312,7 @@ Read linker script from Set address of section. .It Fl -shared Build a shared object. -.It Fl -soname= Ns Ar value +.It Fl -soname Ns = Ns Ar value Set .Dv DT_SONAME to @@ -327,7 +329,7 @@ Strip debugging information. .It Fl -symbol-ordering-file Ar file Lay out sections in the order specified by .Ar file . -.It Fl -sysroot= Ns Ar value +.It Fl -sysroot Ns = Ns Ar value Set the system root. .It Fl -target1-abs Interpret @@ -339,7 +341,7 @@ Interpret .Dv R_ARM_TARGET1 as .Dv R_ARM_REL32 . -.It Fl -target2=type +.It Fl -target2 Ns = Ns Ar type Interpret .Dv R_ARM_TARGET2 as @@ -347,10 +349,10 @@ as where .Ar type is one of -.Li rel , -.Li abs , +.Cm rel , +.Cm abs , or -.Li got-rel . +.Cm got-rel . .It Fl -Tbss Ar value Same as .Fl -section-start @@ -363,11 +365,11 @@ Same as with .Li .data as the sectionname. -.It Fl -thinlto-cache-dir= Ns Ar value +.It Fl -thinlto-cache-dir Ns = Ns Ar value Path to ThinLTO cached object file directory. .It Fl -thinlto-cache-policy Ar value Pruning policy for the ThinLTO cache. -.It Fl -thinlto-jobs= Ns Ar value +.It Fl -thinlto-jobs Ns = Ns Ar value Number of ThinLTO jobs. .It Fl -threads Run the linker multi-threaded. @@ -387,7 +389,7 @@ as the sectionname. Force .Ar symbol to be an undefined symbol during linking. -.It Fl -unresolved-symbols= Ns Ar value +.It Fl -unresolved-symbols Ns = Ns Ar value Determine how to handle unresolved symbols. .It Fl -verbose Verbose mode. @@ -466,7 +468,7 @@ section read-only. The .Dv DT_DEBUG tag will not be emitted. -.It Cm stack-size= Ns Ar size +.It Cm stack-size Ns = Ns Ar size Set the main thread's stack size to .Ar size . The stack size is recorded as the size of the @@ -485,7 +487,7 @@ segment. .Sh IMPLEMENTATION NOTES .Nm Ap s handing of archive files (those with a -.Cm .a +.Pa .a file extension) is different from traditional linkers used on Unix-like systems. .Pp -- 2.7.4