diff options
author | Jim Meyering <meyering@redhat.com> | 2008-10-12 19:53:20 +0200 |
---|---|---|
committer | Jim Meyering <meyering@redhat.com> | 2008-10-12 19:53:20 +0200 |
commit | 969841cb77fe2fc95959eb740809547b29381bd8 (patch) | |
tree | 72fc31a06ad6b1ebea7fc82be847938428c1ae8f | |
parent | c3e1fe230b9858d94299ab6f106d4e37fa4a6d75 (diff) | |
download | coreutils-969841cb77fe2fc95959eb740809547b29381bd8.tar.xz |
doc: reorder tsort/ptx nodes so body and menu ordering are consistent
* doc/coreutils.texi (tsort invocation, tsort background): Move these
nodes "down", so that they follow the ptx nodes, thus matching the
alphabetized order in the menu.
(tsort background): Make this a subsection.
Suggested by Karl Berry.
-rw-r--r-- | doc/coreutils.texi | 313 |
1 files changed, 158 insertions, 155 deletions
diff --git a/doc/coreutils.texi b/doc/coreutils.texi index 11b9ab9da..a0d220263 100644 --- a/doc/coreutils.texi +++ b/doc/coreutils.texi @@ -3562,7 +3562,6 @@ These commands work with (or produce) sorted files. * comm invocation:: Compare two sorted files line by line. * ptx invocation:: Produce a permuted index of file contents. * tsort invocation:: Topological sort. -* tsort background:: Where tsort came from. @end menu @@ -4587,160 +4586,6 @@ The delimiter @var{str} may not be empty. @end table -@node tsort invocation -@section @command{tsort}: Topological sort - -@pindex tsort -@cindex topological sort - -@command{tsort} performs a topological sort on the given @var{file}, or -standard input if no input file is given or for a @var{file} of -@samp{-}. For more details and some history, see @ref{tsort background}. -Synopsis: - -@example -tsort [@var{option}] [@var{file}] -@end example - -@command{tsort} reads its input as pairs of strings, separated by blanks, -indicating a partial ordering. The output is a total ordering that -corresponds to the given partial ordering. - -For example - -@example -tsort <<EOF -a b c -d -e f -b c d e -EOF -@end example - -@noindent -will produce the output - -@example -a -b -c -d -e -f -@end example - -Consider a more realistic example. -You have a large set of functions all in one file, and they may all be -declared static except one. Currently that one (say @code{main}) is the -first function defined in the file, and the ones it calls directly follow -it, followed by those they call, etc. Let's say that you are determined -to take advantage of prototypes, so you have to choose between declaring -all of those functions (which means duplicating a lot of information from -the definitions) and rearranging the functions so that as many as possible -are defined before they are used. One way to automate the latter process -is to get a list for each function of the functions it calls directly. -Many programs can generate such lists. They describe a call graph. -Consider the following list, in which a given line indicates that the -function on the left calls the one on the right directly. - -@example -main parse_options -main tail_file -main tail_forever -tail_file pretty_name -tail_file write_header -tail_file tail -tail_forever recheck -tail_forever pretty_name -tail_forever write_header -tail_forever dump_remainder -tail tail_lines -tail tail_bytes -tail_lines start_lines -tail_lines dump_remainder -tail_lines file_lines -tail_lines pipe_lines -tail_bytes xlseek -tail_bytes start_bytes -tail_bytes dump_remainder -tail_bytes pipe_bytes -file_lines dump_remainder -recheck pretty_name -@end example - -then you can use @command{tsort} to produce an ordering of those -functions that satisfies your requirement. - -@example -example$ tsort call-graph | tac -dump_remainder -start_lines -file_lines -pipe_lines -xlseek -start_bytes -pipe_bytes -tail_lines -tail_bytes -pretty_name -write_header -tail -recheck -parse_options -tail_file -tail_forever -main -@end example - -@command{tsort} detects any cycles in the input and writes the first cycle -encountered to standard error. - -Note that for a given partial ordering, generally there is no unique -total ordering. In the context of the call graph above, the function -@code{parse_options} may be placed anywhere in the list as long as it -precedes @code{main}. - -The only options are @option{--help} and @option{--version}. @xref{Common -options}. - -@exitstatus - -@node tsort background -@section @command{tsort}: Background - -@command{tsort} exists because very early versions of the Unix linker processed -an archive file exactly once, and in order. As @command{ld} read each object -in the archive, it decided whether it was needed in the program based on -whether it defined any symbols which were undefined at that point in -the link. - -This meant that dependencies within the archive had to be handled -specially. For example, @code{scanf} probably calls @code{read}. That means -that in a single pass through an archive, it was important for @code{scanf.o} -to appear before read.o, because otherwise a program which calls -@code{scanf} but not @code{read} might end up with an unexpected unresolved -reference to @code{read}. - -The way to address this problem was to first generate a set of -dependencies of one object file on another. This was done by a shell -script called @command{lorder}. The GNU tools don't provide a version of -lorder, as far as I know, but you can still find it in BSD -distributions. - -Then you ran @command{tsort} over the @command{lorder} output, and you used the -resulting sort to define the order in which you added objects to the archive. - -This whole procedure has been obsolete since about 1980, because -Unix archives now contain a symbol table (traditionally built by -@command{ranlib}, now generally built by @command{ar} itself), and the Unix -linker uses the symbol table to effectively make multiple passes over -an archive file. - -Anyhow, that's where tsort came from. To solve an old problem with -the way the linker handled archive files, which has since been solved -in different ways. - - @node ptx invocation @section @command{ptx}: Produce permuted indexes @@ -5196,6 +5041,164 @@ allowed with System V @command{ptx}. @end itemize +@node tsort invocation +@section @command{tsort}: Topological sort + +@pindex tsort +@cindex topological sort + +@command{tsort} performs a topological sort on the given @var{file}, or +standard input if no input file is given or for a @var{file} of +@samp{-}. For more details and some history, see @ref{tsort background}. +Synopsis: + +@example +tsort [@var{option}] [@var{file}] +@end example + +@command{tsort} reads its input as pairs of strings, separated by blanks, +indicating a partial ordering. The output is a total ordering that +corresponds to the given partial ordering. + +For example + +@example +tsort <<EOF +a b c +d +e f +b c d e +EOF +@end example + +@noindent +will produce the output + +@example +a +b +c +d +e +f +@end example + +Consider a more realistic example. +You have a large set of functions all in one file, and they may all be +declared static except one. Currently that one (say @code{main}) is the +first function defined in the file, and the ones it calls directly follow +it, followed by those they call, etc. Let's say that you are determined +to take advantage of prototypes, so you have to choose between declaring +all of those functions (which means duplicating a lot of information from +the definitions) and rearranging the functions so that as many as possible +are defined before they are used. One way to automate the latter process +is to get a list for each function of the functions it calls directly. +Many programs can generate such lists. They describe a call graph. +Consider the following list, in which a given line indicates that the +function on the left calls the one on the right directly. + +@example +main parse_options +main tail_file +main tail_forever +tail_file pretty_name +tail_file write_header +tail_file tail +tail_forever recheck +tail_forever pretty_name +tail_forever write_header +tail_forever dump_remainder +tail tail_lines +tail tail_bytes +tail_lines start_lines +tail_lines dump_remainder +tail_lines file_lines +tail_lines pipe_lines +tail_bytes xlseek +tail_bytes start_bytes +tail_bytes dump_remainder +tail_bytes pipe_bytes +file_lines dump_remainder +recheck pretty_name +@end example + +then you can use @command{tsort} to produce an ordering of those +functions that satisfies your requirement. + +@example +example$ tsort call-graph | tac +dump_remainder +start_lines +file_lines +pipe_lines +xlseek +start_bytes +pipe_bytes +tail_lines +tail_bytes +pretty_name +write_header +tail +recheck +parse_options +tail_file +tail_forever +main +@end example + +@command{tsort} detects any cycles in the input and writes the first cycle +encountered to standard error. + +Note that for a given partial ordering, generally there is no unique +total ordering. In the context of the call graph above, the function +@code{parse_options} may be placed anywhere in the list as long as it +precedes @code{main}. + +The only options are @option{--help} and @option{--version}. @xref{Common +options}. + +@exitstatus + +@menu +* tsort background:: Where tsort came from. +@end menu + +@node tsort background +@subsection @command{tsort}: Background + +@command{tsort} exists because very early versions of the Unix linker processed +an archive file exactly once, and in order. As @command{ld} read each object +in the archive, it decided whether it was needed in the program based on +whether it defined any symbols which were undefined at that point in +the link. + +This meant that dependencies within the archive had to be handled +specially. For example, @code{scanf} probably calls @code{read}. That means +that in a single pass through an archive, it was important for @code{scanf.o} +to appear before read.o, because otherwise a program which calls +@code{scanf} but not @code{read} might end up with an unexpected unresolved +reference to @code{read}. + +The way to address this problem was to first generate a set of +dependencies of one object file on another. This was done by a shell +script called @command{lorder}. The GNU tools don't provide a version of +lorder, as far as I know, but you can still find it in BSD +distributions. + +Then you ran @command{tsort} over the @command{lorder} output, and you used the +resulting sort to define the order in which you added objects to the archive. + +This whole procedure has been obsolete since about 1980, because +Unix archives now contain a symbol table (traditionally built by +@command{ranlib}, now generally built by @command{ar} itself), and the Unix +linker uses the symbol table to effectively make multiple passes over +an archive file. + +Anyhow, that's where tsort came from. To solve an old problem with +the way the linker handled archive files, which has since been solved +in different ways. + + @node Operating on fields within a line @chapter Operating on fields within a line |