Commit Graph

13 Commits

Author SHA1 Message Date
Peter Wang
10d29a489a Generate better man pages.
doc/make_manpage:
    Replace the old script with a new version written in awk.

    The new output should be an improvement in these ways:
      - works for tools that use spaces for indentation instead of tabs
      - uses macros for indenting proportional font text
        instead of monospace text with inconsistent leading spaces
      - option names are in bold
      - removes redundant blank lines

doc/Mmakefile:
    Adjust command line to call the new make_manpage script.

compiler/options.m:
    Minor formatting changes to --help text to keep complexity of
    make_manpage script low.

profiler/mercury_profile.m:
    Add "Name:" line to --help output for make_manpage to read.

scripts/mtags.in:
    Add "Name:" line to --help output for make_manpage to read.

    Delete initial blank line in help and usage text.

    Delete stray full stop.

scripts/mprof_merge_runs:
scripts/parse_ml_options.sh-subr.in:
    Simplify --help text for make_manpage.
2019-05-28 15:54:45 +10:00
Julien Fischer
b430a6e2e4 Fix a problem with generating the manual pages on Mac OS X.
doc/make_manpage:
	BSD sed has problems with line continuations in some cases.
	Avoid using them where this is an issue.
2013-06-04 15:14:48 +10:00
Julien Fischer
b995aebcc0 Update email addresses and URLs.
.README.in:
BUGS:
README.CSharp:
README.DotNet:
README.Erlang:
README.Java:
README.ThreadScope:
compiler/notes/todo.html:
doc/faq.texi:
doc/make_manpage:
	As above.
2013-04-24 16:13:59 +10:00
Julien Fischer
576600811f Prepare for the 0.13 release and fix/update documentation.
Estimated hours taken: 1
Branches: main, release

Prepare for the 0.13 release and fix/update documentation.

NEWS:
HISTORY:
	Update the NEWS and HISTORY files for the 0.13 release.

RELEASE_NOTES:
	s/0.12/0.13/

	Add Linux/x86_64 to the list of architectures supported by this
	release.

	Remove Solaris 8/x86 from the same list.

.README.in:
extras/README:
	Remove references to the clp(r) binding.  We no longer support it.

bindist/bindist.README:
	Update the year in the copyright message.

	Fix the gc version; 0.13 uses 6.5.

BUGS:
README.DotNet:
README.Java:
README.gcc-backend:
doc/faq.texi:
doc/make_manpage:
doc/mercury.html.in:
doc/mercury.info.in:
	s/.cs.mu.oz.au/.csse.unimelb.edu.au/

library/array.m:
library/builtin.m:
library/eqvclass.m:
library/graph.m:
samples/README:
	Fix typos.
2006-09-07 08:32:20 +00:00
Fergus Henderson
d77a28de20 Handle sub-headings better.
Branches: main
Estimated hours taken: 3

doc/make_manpage:
	Handle sub-headings better.
2002-10-10 10:43:32 +00:00
Fergus Henderson
0a46b1e5e4 Allow "/" characters in section headings, so that it works
Estimated hours taken: 0.25
Branches: main

doc/make_manpage:
	Allow "/" characters in section headings, so that it works
	correctly for the heading "dynamic/static linking options".
2002-02-05 12:06:14 +00:00
Fergus Henderson
32df00846e Update a dangling URL.
Estimated hours taken: 0.1

doc/make_manpage:
	Update a dangling URL.
2000-11-02 11:06:42 +00:00
Fergus Henderson
c5dc9a1c99 Update the URL for the Mercury documentation.
Estimated hours taken: 0.25

doc/make_manpage:
	Update the URL for the Mercury documentation.
1998-12-16 17:02:45 +00:00
Tyson Dowd
109e77782e Fix spelling mistake.
Estimated hours taken: 0.05

doc/make_manpage:
	Fix spelling mistake.
	s/SYNOPSYS/SYNOPSIS
1997-09-11 04:51:30 +00:00
Fergus Henderson
04b720630b Update the copyright messages so that (a) they contain the correct years
and (b) they say "Copyright (C) ... _The_ University of Melbourne".
1997-07-27 15:09:59 +00:00
Fergus Henderson
856082398d Fix some problems with the man pages, and make sure they get installed.
Estimated hours taken: 1

Fix some problems with the man pages, and make sure they get installed.

doc/make_manpages:
	Fix a problem in the formatting of the `mmake' manpage.

doc/Mmakefile:
	Make sure that `mmake install' will install the manpages.
	Also change the handling of `mmake clean' so that it cleans
	up the manpages.
1997-02-26 09:21:39 +00:00
Fergus Henderson
941837ff39 Fix a bug: when creating the man pages, we execute the various
Estimated hours taken: 0.25

doc/Mmake:
	Fix a bug: when creating the man pages, we execute the various
	programs (with `--help') via their scripts.  We need to pass the
	appropriate environment variables to the scripts to make sure
	that the scripts execute the local versions in ../compiler,
	../profiler, and ../util.  (After all, they may not have
	even been installed yet.)

doc/make_manpage:
	Insert the "NOTES:" section before the "ARGUMENTS:" section,
	if any, rather than always inserting it before the "OPTIONS:"
	section.
1997-02-10 13:38:17 +00:00
Fergus Henderson
cb5b100205 Add Unix-style man pages for most of the Mercury development tools.
Estimated hours taken: 5

Add Unix-style man pages for most of the Mercury development tools.

doc/make_manpage:
	New file.  This is a shell script that converts the
	output from `foo --help' into a a man page.

doc/Mmake:
	New rules for creating and installing man pages.
	Also add some rules for installing the postscript
	and text
1997-02-07 14:17:16 +00:00