From: Michael Meffie <mmeffie@sinenomine.net>
Date: Mon, 20 Jan 2014 19:37:52 +0000 (-0500)
Subject: doc: afs_compile_et -h option
X-Git-Tag: upstream/1.6.10_pre1^2~88
X-Git-Url: https://git.michaelhowe.org/gitweb/?a=commitdiff_plain;h=619448f16c91b496e7dc2cc9b24dfbff38fabd73;p=packages%2Fo%2Fopenafs.git

doc: afs_compile_et -h option

Document the afs_compile_et -h option.

Reviewed-on: http://gerrit.openafs.org/10722
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Benjamin Kaduk <kaduk@mit.edu>
Reviewed-by: Derrick Brashear <shadow@your-file-system.com>
(cherry picked from commit 501d6d288fcaa195c3cda0be0e3423c7959c9958)

Change-Id: I5085f35d1b75a6dbae2768c2ba1ea61bb9c4201c
Reviewed-on: http://gerrit.openafs.org/11226
Reviewed-by: Perry Ruiter <pruiter@sinenomine.net>
Reviewed-by: Stephan Wiesand <stephan.wiesand@desy.de>
Tested-by: Stephan Wiesand <stephan.wiesand@desy.de>
---

diff --git a/doc/man-pages/pod1/afs_compile_et.pod b/doc/man-pages/pod1/afs_compile_et.pod
index 6f1666276..eaa1b4907 100644
--- a/doc/man-pages/pod1/afs_compile_et.pod
+++ b/doc/man-pages/pod1/afs_compile_et.pod
@@ -8,7 +8,8 @@ afs_compile_et - Produce error text tables for compilation
 <div class="synopsis">
 
 B<afs_compile_et> [B<-debug>] S<<< [B<-language> <I<lang>>] >>>
-    S<<< [B<-prefix> <I<prefix>>] >>> S<<< [B<-v> <I<version>>] >>> <I<error_table>>
+    S<<< [B<-prefix> <I<prefix>>] >>> S<<< [B<-v> <I<version>>] >>>
+    S<<< [B<-h> <I<include>>] >>> <I<error_table>>
 
 =for html
 </div>
@@ -53,8 +54,25 @@ The B<-lang> <I<lang>> option is a synonym for B<-language> <I<lang>>>.
 
 =item B<-prefix> <I<prefix>>
 
-Specifies the directory to search for the F<error_table.et> file.
-The B<-p> <I<prefix>> option is a synonym for B<-prefix> <I<prefix>>.
+Specifies the directory to search for the F<error_table.et> file. Specifies
+the directory to search for the prolog file when the B<-h> option is
+given.  The B<-p> <I<prefix>> option is a synonym for B<-prefix> <I<prefix>>.
+
+=item B<-h> <I<include>>
+
+Specifies an input file, called a prolog file, and modifies the name of the
+header file generated by B<afs_compile_et>.
+
+When the B<-h> option is given, B<afs_compile_et> will search for a prolog file
+named <I<include>>F<.p.h>.  B<afs_compile_et> will search the current working
+directory for the prolog file, unless the B<-p> option is given.  If the prolog
+file is found, B<afs_compile_et> will place a verbatim copy of the prolog
+file contents into the generated header file.
+
+When the B<-h> option is given, the name of the header file generated by
+B<afs_compile_et> is <I<include>>F<.h>, instead of <I<error_table>>F<.h>.
+
+The B<-h> option does not affect the source file generated by B<afs_compile_et>.
 
 =item B<-v> <I<version>>