From patchwork Thu Oct 16 08:46:55 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Rical Jasan X-Patchwork-Id: 3242 Received: (qmail 24768 invoked by alias); 16 Oct 2014 08:46:14 -0000 Mailing-List: contact libc-alpha-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Unsubscribe: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: libc-alpha-owner@sourceware.org Delivered-To: mailing list libc-alpha@sourceware.org Received: (qmail 24700 invoked by uid 89); 16 Oct 2014 08:46:13 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-1.1 required=5.0 tests=AWL, BAYES_00, SPF_PASS, T_RP_MATCHES_RCVD autolearn=ham version=3.3.2 X-HELO: mail.pacific.net Message-ID: <543F85FF.7070400@pacific.net> Date: Thu, 16 Oct 2014 01:46:55 -0700 From: ricaljasan User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:31.0) Gecko/20100101 Thunderbird/31.1.2 MIME-Version: 1.0 To: libc-alpha@sourceware.org Subject: [PATCH] Clean up safety property macros. X-Null-Tag: 0adf41b933113f8faaad17b4d1763faa 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 * 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