This is the mail archive of the libc-alpha@sourceware.org mailing list for the glibc 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]

[PATCH] Clean up safety property macros.


The @prelim macro contained an unused parameter and included an
unnecessary trailing colon, which caused safety property documentation
to look odd.  The @sampsafety macro included an unnecessary vertical
bar at the end of the template which also caused output to look
strange.  These changes clean up the appearance of safety property
documentation throughout the manual.

    * manual/intro.texi: Indent safety property template.
    * manual/macros.texi: Remove unused parameter from @prelim macro
      and fix comment.  Remove trailing colon from @prelim.  Remove
      trailng vertical bar from @sampsafety.

2014-10-11  Rical Jasan  <redacted>

	* manual/intro.texi (POSIX Safety Concepts): Add @indent command.
	* manual/macros.texi (prelim): Remove unused parameter.  Update
	comment.  Remove trailing colon.
	(sampsafety): Remove trailing vertical bar.
diff --git a/manual/intro.texi b/manual/intro.texi
index d4045f2..a1708ef 100644
--- a/manual/intro.texi
+++ b/manual/intro.texi
@@ -187,6 +187,7 @@ pattern matching facilities (@pxref{Pattern Matching}).
 This manual documents various safety properties of @glibcadj{}
 functions, in lines that follow their prototypes and look like:
 
+@indent
 @sampsafety{@prelim{}@mtsafe{}@assafe{}@acsafe{}}
 
 The properties are assessed according to the criteria set forth in the
diff --git a/manual/macros.texi b/manual/macros.texi
index f32c86d..3b72318 100644
--- a/manual/macros.texi
+++ b/manual/macros.texi
@@ -47,10 +47,9 @@ GNU/Hurd systems
 GNU/Linux systems
 @end macro
 
-@c Document the safety functions as preliminary.  It does NOT expand its
-@c comments.
-@macro prelim {comments}
-Preliminary:
+@c Document the safety functions as preliminary.
+@macro prelim
+Preliminary
 
 @end macro
 @c Document a function as thread safe.
@@ -93,7 +92,7 @@ Preliminary:
 @c themselves.
 @macro sampsafety {notes}
 @noindent
-\notes\|
+\notes\
 
 
 @end macro

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