This is the mail archive of the gcc-patches@gcc.gnu.org mailing list for the GCC project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

[Ada, DOC] PR15479: Do not document gnathtml


'make info dvi pdf html' passed.  OK for trunk?

BTW, an alternative could be to wrap the nodes in @ignore/@end ignore,
if you would like to keep the content in the file.

There are a couple more minor points in that PR which I hope to address
now, so that it can finally die.  :-)

Thanks,
Ralf

gcc/ada/ChangeLog:
2008-07-20  Ralf Wildenhues  <Ralf.Wildenhues@gmx.de>

	PR documentation/15479
	* gnat_ugn.texi (Converting Ada Files to html with gnathtml)
	(Installing gnathtml): Remove nodes.
	(Top, What This Guide Contains, Other Utility Programs): Adjust.

diff --git a/gcc/ada/gnat_ugn.texi b/gcc/ada/gnat_ugn.texi
index b55f398..c2d40ac 100644
--- a/gcc/ada/gnat_ugn.texi
+++ b/gcc/ada/gnat_ugn.texi
@@ -500,7 +500,6 @@ Other Utility Programs
 
 * Using Other Utility Programs with GNAT::
 * The External Symbol Naming Scheme of GNAT::
-* Converting Ada Files to html with gnathtml::
 
 @ifclear vms
 Code Coverage and Profiling
@@ -846,8 +845,7 @@ a utility that checks Ada code against a set of rules.
 a utility that generates empty but compilable bodies for library units.
 
 @item
-@ref{Other Utility Programs}, discusses several other GNAT utilities,
-including @code{gnathtml}.
+@ref{Other Utility Programs}, discusses several other GNAT utilities.
 
 @ifclear vms
 @item
@@ -22170,8 +22168,6 @@ environment.
 @menu
 * Using Other Utility Programs with GNAT::
 * The External Symbol Naming Scheme of GNAT::
-* Converting Ada Files to html with gnathtml::
-* Installing gnathtml::
 @ifset vms
 * LSE::
 * Profiling::
@@ -22266,131 +22262,6 @@ procedure Hello (S : String);
 the external name of this procedure will be @var{_ada_hello}.
 
 
-@node Converting Ada Files to html with gnathtml
-@section Converting Ada Files to HTML with @code{gnathtml}
-
-@noindent
-This @code{Perl} script allows Ada source files to be browsed using
-standard Web browsers. For installation procedure, see the section
-@xref{Installing gnathtml}.
-
-Ada reserved keywords are highlighted in a bold font and Ada comments in
-a blue font. Unless your program was compiled with the gcc @option{-gnatx}
-switch to suppress the generation of cross-referencing information, user
-defined variables and types will appear in a different color; you will
-be able to click on any identifier and go to its declaration.
-
-The command line is as follow:
-@smallexample
-$ perl gnathtml.pl @ovar{^switches^options^} @var{ada-files}
-@end smallexample
-
-@noindent
-You can pass it as many Ada files as you want. @code{gnathtml} will generate
-an html file for every ada file, and a global file called @file{index.htm}.
-This file is an index of every identifier defined in the files.
-
-The available ^switches^options^ are the following ones:
-
-@table @option
-@item -83
-@cindex @option{-83} (@code{gnathtml})
-Only the Ada 83 subset of keywords will be highlighted.
-
-@item -cc @var{color}
-@cindex @option{-cc} (@code{gnathtml})
-This option allows you to change the color used for comments. The default
-value is green. The color argument can be any name accepted by html.
-
-@item -d
-@cindex @option{-d} (@code{gnathtml})
-If the Ada files depend on some other files (for instance through
-@code{with} clauses, the latter files will also be converted to html.
-Only the files in the user project will be converted to html, not the files
-in the run-time library itself.
-
-@item -D
-@cindex @option{-D} (@code{gnathtml})
-This command is the same as @option{-d} above, but @command{gnathtml} will
-also look for files in the run-time library, and generate html files for them.
-
-@item -ext @var{extension}
-@cindex @option{-ext} (@code{gnathtml})
-This option allows you to change the extension of the generated HTML files.
-If you do not specify an extension, it will default to @file{htm}.
-
-@item -f
-@cindex @option{-f} (@code{gnathtml})
-By default, gnathtml will generate html links only for global entities
-('with'ed units, global variables and types,@dots{}).  If you specify
-@option{-f} on the command line, then links will be generated for local
-entities too.
-
-@item -l @var{number}
-@cindex @option{-l} (@code{gnathtml})
-If this ^switch^option^ is provided and @var{number} is not 0, then
-@code{gnathtml} will number the html files every @var{number} line.
-
-@item -I @var{dir}
-@cindex @option{-I} (@code{gnathtml})
-Specify a directory to search for library files (@file{.ALI} files) and
-source files. You can provide several -I switches on the command line,
-and the directories will be parsed in the order of the command line.
-
-@item -o @var{dir}
-@cindex @option{-o} (@code{gnathtml})
-Specify the output directory for html files. By default, gnathtml will
-saved the generated html files in a subdirectory named @file{html/}.
-
-@item -p @var{file}
-@cindex @option{-p} (@code{gnathtml})
-If you are using Emacs and the most recent Emacs Ada mode, which provides
-a full Integrated Development Environment for compiling, checking,
-running and debugging applications, you may use @file{.gpr} files
-to give the directories where Emacs can find sources and object files.
-
-Using this ^switch^option^, you can tell gnathtml to use these files.
-This allows you to get an html version of your application, even if it
-is spread over multiple directories.
-
-@item -sc @var{color}
-@cindex @option{-sc} (@code{gnathtml})
-This ^switch^option^ allows you to change the color used for symbol
-definitions.
-The default value is red. The color argument can be any name accepted by html.
-
-@item -t @var{file}
-@cindex @option{-t} (@code{gnathtml})
-This ^switch^option^ provides the name of a file. This file contains a list of
-file names to be converted, and the effect is exactly as though they had
-appeared explicitly on the command line. This
-is the recommended way to work around the command line length limit on some
-systems.
-
-@end table
-
-@node Installing gnathtml
-@section Installing @code{gnathtml}
-
-@noindent
-@code{Perl} needs to be installed on your machine to run this script.
-@code{Perl} is freely available for almost every architecture and
-Operating System via the Internet.
-
-On Unix systems, you  may want to modify  the  first line of  the script
-@code{gnathtml},  to explicitly  tell  the Operating  system  where Perl
-is. The syntax of this line is:
-@smallexample
-#!full_path_name_to_perl
-@end smallexample
-
-@noindent
-Alternatively, you may run the script using the following command line:
-
-@smallexample
-$ perl gnathtml.pl @ovar{switches} @var{files}
-@end smallexample
-
 @ifset vms
 @node LSE
 @section LSE


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]