head	2.5;
access;
symbols;
locks; strict;
comment	@# @;


2.5
date	95.06.03.04.52.38;	author grog;	state Exp;
branches;
next	2.4;

2.4
date	95.02.03.13.21.06;	author grog;	state Exp;
branches;
next	2.3;

2.3
date	95.01.26.16.55.38;	author grog;	state Exp;
branches;
next	2.2;

2.2
date	95.01.26.10.43.17;	author grog;	state Exp;
branches;
next	2.1;

2.1
date	95.01.09.14.20.45;	author grog;	state Exp;
branches;
next	2.0;

2.0
date	94.12.17.15.19.19;	author grog;	state Exp;
branches;
next	;


desc
@@


2.5
log
@Major mods after Andy's review
@
text
@How to tidy up a source file:

Bad words:
- no future: will
- no passive: are, be, is, been, by
- normally no however, generally
- maybe no might, probably, get active, necessarily (thanks, JHC)
  just
  the fact
  gets

- justify C comments (c-mode) to col 30
- fewer "Note that"
- 'only' after verb
- which->that
- no dangling references: check this, these
- opposite->converse
- replace -- with ".  "?
- remove ... which defines
- \\ -> \e
- control characters CTRL-M, not ^M
- Less first person (-> you)
- suffices->suffixes

- 2 spaces after periods:
(query-replace-regexp "\\. \\([^ 
]\\)" ".  \\1" nil)

- don't run __ together:
(query-replace-regexp "__" "_\\\\/_" nil)

- untabify

Check indented quotations

-- Indices for authors: search for " ["

check for tabu words:
- source program
- compiler option (->flag)
- portation
- configurability
- pid->Process ID
- i.e, e.g.
- super-user -> superuser
- file name extension->suffix

Tables: .sp .4v between items
 .ne 10 before
 remove center, 

Remove initial letter highlights (?)

Second level lists; .Ls B "" "\-"

Make sure we have a summary.

-- correct sequence in CW
(query-replace-regexp "\\\\f(CW\\\\s10" "\\\\s10\\\\f(CW" nil)
(query-replace-regexp "\\\\s0\\\\fR" "\\\\fR\\\\s0" nil)


Index stuff:

- F6 indexes all \fI stuff
- check tables
- text in lower case unless good reason
-- repeat section header as index hit
(query-replace-regexp "\\(\\.[ABC]h \"\\)\\(.*\\)\"" "\\1\\2\"
.XX \"\\2\"" nil)
-- function call from section header
(query-replace-regexp "\\([ABC]\\)h \"\\(.*\\)\"" "\\1h \"\\2\"
.XX \"\\2, function call\"
.XX \"function call, \\2\"" nil)
-- Xref for first column of a table
(query-replace-regexp "^\\([^ #\\{}
]+\\)#" ".XX \"\\1\"
\\1#" nil)
-- add .XX "foo, bar" to .XX "bar, foo"
(query-replace-regexp "XX \"\\(.*\\), \\(.*\\)\"$" "XX \"\\1, \\2\"
.XX \"\\2, \\1\"" nil)
-- refs for well-known structs
(query-replace-regexp "^struct +\\([^ 	;
]+\\)" ".XX \"struct, \\1\"
".XX \"\\1, struct\"
struct \\1" nil)

Version 1.11:

Put in C shell equivalents to Bourne shell scripts

Version 1.13:

ise -> ize
Xenix -> XENIX

Version 2.0:

Get fonts in tables right for big macros

Version 2.2:

Replace .RS/.RE with .QS/.QE
Get file names for CD-ROM files into appcdrom.

V 2.4

Change .QQE to .QE when new macros become available
check comma  after page number and chapter refs
----------------------------------------

$Id: totidy,v 2.4 1995/02/03 13:21:06 grog Exp grog $

$Log: totidy,v $
# Revision 2.4  1995/02/03  13:21:06  grog
# Minor mods
#
# Revision 2.3  1995/01/26  16:55:38  grog
# Minor mods
#
# Revision 2.2  1995/01/26  10:43:17  grog
# Minor mods
#
# Revision 2.1  1995/01/09  14:20:45  grog
# Minor mods
#
@


2.4
log
@Minor mods
@
text
@d3 1
d8 4
d29 3
d112 1
a112 1
$Id: totidy,v 2.3 1995/01/26 16:55:38 grog Exp grog $
d115 3
@


2.3
log
@Minor mods
@
text
@a57 1
- check headings, repeat if necessary
d97 5
d104 1
a104 1
$Id: totidy,v 2.2 1995/01/26 10:43:17 grog Exp grog $
d107 3
@


2.2
log
@Minor mods
@
text
@d97 1
a97 1

d100 1
a100 1
$Id: totidy,v 2.1 1995/01/09 14:20:45 grog Exp grog $
d103 3
@


2.1
log
@Minor mods
@
text
@d94 4
d100 1
a100 1
$Id: totidy,v 2.0 1994/12/17 15:19:19 grog Exp grog $
d103 3
@


2.0
log
@checked in with -k by grog at 1995/01/09 13:22:41
@
text
@d90 4
d96 1
a96 1
$Id: totidy,v 1.13 1994/12/17 15:19:19 grog Exp grog $
a98 25
# Revision 1.13  1994/12/17  15:19:19  grog
# Minor mods
#
# Revision 1.12  1994/12/17  15:18:48  grog
# Minor mods
#
# Revision 1.10  1994/12/14  13:42:42  grog
# Monir mods
#
# Revision 1.6  1994/11/25  15:39:50  grog
# Minor mods
#
# Revision 1.5  1994/11/20  15:38:39  grog
# Minor mods
#
# Revision 1.4  1994/11/18  14:24:20  grog
# Minor mods
#
# Revision 1.3  1994/10/19  09:25:07  grog
# Minor changes
#
# Revision 1.2  1994/08/06  12:37:20  grog
# Minor changes
#

@