[llvm-commits] CVS: llvm/docs/CommandGuide/analyze.pod bugpoint.pod extract.pod gccas.pod gccld.pod llc.pod lli.pod llvm-as.pod llvm-bcanalyzer.pod llvm-db.pod llvm-dis.pod llvm-link.pod llvm-nm.pod llvm-prof.pod llvmgcc.pod llvmgxx.pod opt.pod
Misha Brukman
brukman at cs.uiuc.edu
Fri Jul 2 11:09:06 PDT 2004
Changes in directory llvm/docs/CommandGuide:
analyze.pod updated: 1.1 -> 1.2
bugpoint.pod updated: 1.3 -> 1.4
extract.pod updated: 1.1 -> 1.2
gccas.pod updated: 1.3 -> 1.4
gccld.pod updated: 1.1 -> 1.2
llc.pod updated: 1.1 -> 1.2
lli.pod updated: 1.1 -> 1.2
llvm-as.pod updated: 1.1 -> 1.2
llvm-bcanalyzer.pod updated: 1.2 -> 1.3
llvm-db.pod updated: 1.2 -> 1.3
llvm-dis.pod updated: 1.1 -> 1.2
llvm-link.pod updated: 1.1 -> 1.2
llvm-nm.pod updated: 1.1 -> 1.2
llvm-prof.pod updated: 1.2 -> 1.3
llvmgcc.pod updated: 1.2 -> 1.3
llvmgxx.pod updated: 1.1 -> 1.2
opt.pod updated: 1.1 -> 1.2
---
Log message:
* Standardize manpage output: program name bold, options italic/emphasized
* Make links in SEE ALSO section of manpages short without "the ... manpage"
---
Diffs of the changes: (+36 -58)
Index: llvm/docs/CommandGuide/analyze.pod
diff -u llvm/docs/CommandGuide/analyze.pod:1.1 llvm/docs/CommandGuide/analyze.pod:1.2
--- llvm/docs/CommandGuide/analyze.pod:1.1 Thu Jul 1 10:25:04 2004
+++ llvm/docs/CommandGuide/analyze.pod Fri Jul 2 11:06:19 2004
@@ -1,4 +1,3 @@
-
=pod
=head1 NAME
@@ -7,7 +6,7 @@
=head1 SYNOPSIS
-analyze [options] [filename]
+B<analyze> [I<options>] [I<filename>]
=head1 DESCRIPTION
@@ -67,12 +66,10 @@
=head1 SEE ALSO
-L<opt>
+L<opt|opt>
=head1 AUTHORS
Maintained by the LLVM Team (L<http://llvm.cs.uiuc.edu>).
=cut
-
-
Index: llvm/docs/CommandGuide/bugpoint.pod
diff -u llvm/docs/CommandGuide/bugpoint.pod:1.3 llvm/docs/CommandGuide/bugpoint.pod:1.4
--- llvm/docs/CommandGuide/bugpoint.pod:1.3 Fri Jul 2 10:42:20 2004
+++ llvm/docs/CommandGuide/bugpoint.pod Fri Jul 2 11:06:19 2004
@@ -6,7 +6,7 @@
=head1 SYNOPSIS
-bugpoint [options] [input LLVM ll/bc files] [LLVM passes] B<--args>
+B<bugpoint> [I<options>] [I<input LLVM ll/bc files>] [I<LLVM passes>] B<--args>
I<program arguments>
=head1 DESCRIPTION
@@ -240,11 +240,10 @@
=head1 SEE ALSO
-L<opt>, L<analyze>
+L<opt|opt>, L<analyze|analyze>
=head1 AUTHOR
Maintained by the LLVM Team (L<http://llvm.cs.uiuc.edu>).
=cut
-
Index: llvm/docs/CommandGuide/extract.pod
diff -u llvm/docs/CommandGuide/extract.pod:1.1 llvm/docs/CommandGuide/extract.pod:1.2
--- llvm/docs/CommandGuide/extract.pod:1.1 Wed Jun 2 14:21:26 2004
+++ llvm/docs/CommandGuide/extract.pod Fri Jul 2 11:06:19 2004
@@ -1,4 +1,3 @@
-
=pod
=head1 NAME
@@ -7,7 +6,7 @@
=head1 SYNOPSIS
-extract [options] --func function-name [filename]
+B<extract> [I<options>] B<--func> I<function-name> [I<filename>]
=head1 DESCRIPTION
@@ -64,11 +63,10 @@
=head1 SEE ALSO
-L<bugpoint>
+L<bugpoint|bugpoint>
=head1 AUTHORS
Maintained by the LLVM Team (L<http://llvm.cs.uiuc.edu>).
=cut
-
Index: llvm/docs/CommandGuide/gccas.pod
diff -u llvm/docs/CommandGuide/gccas.pod:1.3 llvm/docs/CommandGuide/gccas.pod:1.4
--- llvm/docs/CommandGuide/gccas.pod:1.3 Thu Jul 1 12:59:53 2004
+++ llvm/docs/CommandGuide/gccas.pod Fri Jul 2 11:06:19 2004
@@ -1,4 +1,3 @@
-
=pod
=head1 NAME
@@ -7,7 +6,7 @@
=head1 SYNOPSIS
-gccas [options] filename
+B<gccas> [I<options>] I<filename>
=head1 DESCRIPTION
@@ -68,11 +67,10 @@
=head1 SEE ALSO
-L<llvm-as>, L<gccld>
+L<llvm-as|llvm-as>, L<gccld|gccld>
=head1 AUTHORS
Maintained by the LLVM Team (L<http://llvm.cs.uiuc.edu>).
=cut
-
Index: llvm/docs/CommandGuide/gccld.pod
diff -u llvm/docs/CommandGuide/gccld.pod:1.1 llvm/docs/CommandGuide/gccld.pod:1.2
--- llvm/docs/CommandGuide/gccld.pod:1.1 Thu Jul 1 12:53:27 2004
+++ llvm/docs/CommandGuide/gccld.pod Fri Jul 2 11:06:19 2004
@@ -1,4 +1,3 @@
-
=pod
=head1 NAME
@@ -7,7 +6,7 @@
=head1 SYNOPSIS
-gccld [options] file1 [file2 ...]
+B<gccld> [I<options>] I<filename ...>
=head1 DESCRIPTION
@@ -167,11 +166,10 @@
=head1 SEE ALSO
-L<llvm-link>, L<gccas>
+L<llvm-link|llvm-link>, L<gccas|gccas>
=head1 AUTHORS
Maintained by the LLVM Team (L<http://llvm.cs.uiuc.edu>).
=cut
-
Index: llvm/docs/CommandGuide/llc.pod
diff -u llvm/docs/CommandGuide/llc.pod:1.1 llvm/docs/CommandGuide/llc.pod:1.2
--- llvm/docs/CommandGuide/llc.pod:1.1 Fri May 14 14:50:33 2004
+++ llvm/docs/CommandGuide/llc.pod Fri Jul 2 11:06:19 2004
@@ -1,4 +1,3 @@
-
=pod
=head1 NAME
@@ -7,7 +6,7 @@
=head1 SYNOPSIS
-llc [options] [filename]
+B<llc> [I<options>] [I<filename>]
=head1 DESCRIPTION
@@ -194,11 +193,10 @@
=head1 SEE ALSO
-L<lli>
+L<lli|lli>
=head1 AUTHORS
Maintained by the LLVM Team (L<http://llvm.cs.uiuc.edu>).
=cut
-
Index: llvm/docs/CommandGuide/lli.pod
diff -u llvm/docs/CommandGuide/lli.pod:1.1 llvm/docs/CommandGuide/lli.pod:1.2
--- llvm/docs/CommandGuide/lli.pod:1.1 Fri May 14 14:50:33 2004
+++ llvm/docs/CommandGuide/lli.pod Fri Jul 2 11:06:19 2004
@@ -6,15 +6,15 @@
=head1 SYNOPSIS
-lli [options] [filename] [args ...]
+B<lli> [I<options>] [I<filename>] [I<program args>]
=head1 DESCRIPTION
-B<lli> directly executes programs in LLVM bytecode format. It takes a program in
-LLVM bytecode format and executes it using a just-in-time compiler, if one is
-available for the current architecture, or an interpreter. B<lli> takes
-all of the same code generator options as L<llc|llc>, but they are only effective
-when B<lli> is using the just-in-time compiler.
+B<lli> directly executes programs in LLVM bytecode format. It takes a program
+in LLVM bytecode format and executes it using a just-in-time compiler, if one is
+available for the current architecture, or an interpreter. B<lli> takes all of
+the same code generator options as L<llc|llc>, but they are only effective when
+B<lli> is using the just-in-time compiler.
If I<filename> is not specified, then B<lli> reads the LLVM bytecode for the
program from standard input.
@@ -67,7 +67,7 @@
=head1 SEE ALSO
-L<llc>
+L<llc|llc>
=head1 AUTHOR
Index: llvm/docs/CommandGuide/llvm-as.pod
diff -u llvm/docs/CommandGuide/llvm-as.pod:1.1 llvm/docs/CommandGuide/llvm-as.pod:1.2
--- llvm/docs/CommandGuide/llvm-as.pod:1.1 Wed Jun 2 15:29:49 2004
+++ llvm/docs/CommandGuide/llvm-as.pod Fri Jul 2 11:06:19 2004
@@ -6,7 +6,7 @@
=head1 SYNOPSIS
-llvm-as [options] [filename]
+B<llvm-as> [I<options>] [I<filename>]
=head1 DESCRIPTION
@@ -77,11 +77,10 @@
=head1 SEE ALSO
-L<llvm-dis>, L<gccas>
+L<llvm-dis|llvm-dis>, L<gccas|gccas>
=head1 AUTHORS
Maintained by the LLVM Team (L<http://llvm.cs.uiuc.edu>).
=cut
-
Index: llvm/docs/CommandGuide/llvm-bcanalyzer.pod
diff -u llvm/docs/CommandGuide/llvm-bcanalyzer.pod:1.2 llvm/docs/CommandGuide/llvm-bcanalyzer.pod:1.3
--- llvm/docs/CommandGuide/llvm-bcanalyzer.pod:1.2 Fri Jul 2 10:37:53 2004
+++ llvm/docs/CommandGuide/llvm-bcanalyzer.pod Fri Jul 2 11:06:19 2004
@@ -6,7 +6,7 @@
=head1 SYNOPSIS
-llvm-bcanalyzer [options] [filename]
+B<llvm-bcanalyzer> [I<options>] [I<filename>]
=head1 DESCRIPTION
@@ -57,7 +57,7 @@
=head1 SEE ALSO
-L<llvm-dis>, L<http://llvm.cs.uiuc.edu/docs/BytecodeFormat.html>
+L<llvm-dis|llvm-dis>, L<http://llvm.cs.uiuc.edu/docs/BytecodeFormat.html>
=head1 AUTHORS
Index: llvm/docs/CommandGuide/llvm-db.pod
diff -u llvm/docs/CommandGuide/llvm-db.pod:1.2 llvm/docs/CommandGuide/llvm-db.pod:1.3
--- llvm/docs/CommandGuide/llvm-db.pod:1.2 Thu Jul 1 13:34:46 2004
+++ llvm/docs/CommandGuide/llvm-db.pod Fri Jul 2 11:06:19 2004
@@ -1,4 +1,3 @@
-
=pod
=head1 NAME
@@ -15,4 +14,3 @@
Maintained by the LLVM Team (L<http://llvm.cs.uiuc.edu>).
=cut
-
Index: llvm/docs/CommandGuide/llvm-dis.pod
diff -u llvm/docs/CommandGuide/llvm-dis.pod:1.1 llvm/docs/CommandGuide/llvm-dis.pod:1.2
--- llvm/docs/CommandGuide/llvm-dis.pod:1.1 Wed Jun 2 15:45:25 2004
+++ llvm/docs/CommandGuide/llvm-dis.pod Fri Jul 2 11:06:19 2004
@@ -6,7 +6,7 @@
=head1 SYNOPSIS
-llvm-dis [options] [filename]
+B<llvm-dis> [I<options>] [I<filename>]
=head1 DESCRIPTION
@@ -56,11 +56,10 @@
=head1 SEE ALSO
-L<llvm-as>
+L<llvm-as|llvm-as>
=head1 AUTHORS
Maintained by the LLVM Team (L<http://llvm.cs.uiuc.edu>).
=cut
-
Index: llvm/docs/CommandGuide/llvm-link.pod
diff -u llvm/docs/CommandGuide/llvm-link.pod:1.1 llvm/docs/CommandGuide/llvm-link.pod:1.2
--- llvm/docs/CommandGuide/llvm-link.pod:1.1 Wed Jun 2 15:55:52 2004
+++ llvm/docs/CommandGuide/llvm-link.pod Fri Jul 2 11:06:19 2004
@@ -6,7 +6,7 @@
=head1 SYNOPSIS
-llvm-link [options] filename [...]
+B<llvm-link> [I<options>] I<filename ...>
=head1 DESCRIPTION
Index: llvm/docs/CommandGuide/llvm-nm.pod
diff -u llvm/docs/CommandGuide/llvm-nm.pod:1.1 llvm/docs/CommandGuide/llvm-nm.pod:1.2
--- llvm/docs/CommandGuide/llvm-nm.pod:1.1 Thu Jul 1 14:40:36 2004
+++ llvm/docs/CommandGuide/llvm-nm.pod Fri Jul 2 11:06:19 2004
@@ -6,7 +6,7 @@
=head1 SYNOPSIS
-llvm-nm [options] [filenames...]
+B<llvm-nm> [I<options>] [I<filenames...>]
=head1 DESCRIPTION
@@ -113,11 +113,10 @@
=head1 SEE ALSO
-L<llvm-dis>, L<ar(1)>, L<nm(1)>
+L<llvm-dis|llvm-dis>, L<ar(1)>, L<nm(1)>
=head1 AUTHOR
Maintained by the LLVM Team (L<http://llvm.cs.uiuc.edu>).
=cut
-
Index: llvm/docs/CommandGuide/llvm-prof.pod
diff -u llvm/docs/CommandGuide/llvm-prof.pod:1.2 llvm/docs/CommandGuide/llvm-prof.pod:1.3
--- llvm/docs/CommandGuide/llvm-prof.pod:1.2 Fri May 14 13:31:13 2004
+++ llvm/docs/CommandGuide/llvm-prof.pod Fri Jul 2 11:06:19 2004
@@ -6,7 +6,7 @@
=head1 SYNOPSIS
-llvm-prof [options] [bytecode file] [llvmprof.out]
+B<llvm-prof> [I<options>] [I<bytecode file>] [I<llvmprof.out>]
=head1 DESCRIPTION
@@ -47,12 +47,11 @@
=head1 EXIT STATUS
-B<llvm-prof> returns 1 if it cannot load the bytecode file or the profile
-information. Otherwise, it exits with zero.
+B<llvm-prof|llvm-prof> returns 1 if it cannot load the bytecode file or the
+profile information. Otherwise, it exits with zero.
=head1 AUTHOR
B<llvm-prof> is maintained by the LLVM Team (L<http://llvm.cs.uiuc.edu>).
=cut
-
Index: llvm/docs/CommandGuide/llvmgcc.pod
diff -u llvm/docs/CommandGuide/llvmgcc.pod:1.2 llvm/docs/CommandGuide/llvmgcc.pod:1.3
--- llvm/docs/CommandGuide/llvmgcc.pod:1.2 Thu Jul 1 12:52:58 2004
+++ llvm/docs/CommandGuide/llvmgcc.pod Fri Jul 2 11:06:19 2004
@@ -1,4 +1,3 @@
-
=pod
=head1 NAME
@@ -7,7 +6,7 @@
=head1 SYNOPSIS
-llvmgcc [options] filename
+B<llvmgcc> [I<options>] I<filename>
=head1 DESCRIPTION
@@ -78,7 +77,7 @@
=head1 SEE ALSO
-L<llvmg++|llvmgxx>, L<gccas>, L<gccld>
+L<llvmg++|llvmgxx>, L<gccas|gccas>, L<gccld|gccld>
=head1 AUTHORS
Index: llvm/docs/CommandGuide/llvmgxx.pod
diff -u llvm/docs/CommandGuide/llvmgxx.pod:1.1 llvm/docs/CommandGuide/llvmgxx.pod:1.2
--- llvm/docs/CommandGuide/llvmgxx.pod:1.1 Thu Jul 1 09:51:26 2004
+++ llvm/docs/CommandGuide/llvmgxx.pod Fri Jul 2 11:06:19 2004
@@ -1,4 +1,3 @@
-
=pod
=head1 NAME
@@ -7,7 +6,7 @@
=head1 SYNOPSIS
-llvmg++ [options] filename
+B<llvmg++> [I<options>] I<filename>
=head1 DESCRIPTION
Index: llvm/docs/CommandGuide/opt.pod
diff -u llvm/docs/CommandGuide/opt.pod:1.1 llvm/docs/CommandGuide/opt.pod:1.2
--- llvm/docs/CommandGuide/opt.pod:1.1 Thu Jul 1 10:25:04 2004
+++ llvm/docs/CommandGuide/opt.pod Fri Jul 2 11:06:19 2004
@@ -1,4 +1,3 @@
-
=pod
=head1 NAME
@@ -7,7 +6,7 @@
=head1 SYNOPSIS
-opt [options] [filename]
+B<opt> [I<options>] [I<filename>]
=head1 DESCRIPTION
@@ -89,11 +88,10 @@
=head1 SEE ALSO
-L<analyze>
+L<analyze|analyze>
=head1 AUTHORS
Maintained by the LLVM Team (L<http://llvm.cs.uiuc.edu>).
=cut
-
More information about the llvm-commits
mailing list