From 580b07202d3e6744d8d014aac695c20d33ca7119 Mon Sep 17 00:00:00 2001 From: Werner LEMBERG Date: Tue, 24 Jul 2018 02:46:14 +0200 Subject: [PATCH] doc: Avoid some overfull lines in the TeX output. * doc/glibc-functions/futimesat.texi: Replace a long @code with a @example. * doc/pastposix-functions/pthread_attr_getstackaddr.texi: Insert a newline before the long URL. * doc/pastposix-functions/pthread_attr_setstackaddr.texi: Likewise. * doc/relocatable-maint.texi: Use @smallexample instead of @example. Add line breaks in code snippets. --- ChangeLog | 11 ++++++++++ doc/glibc-functions/futimesat.texi | 9 ++++++-- .../pthread_attr_getstackaddr.texi | 3 ++- .../pthread_attr_setstackaddr.texi | 3 ++- doc/relocatable-maint.texi | 22 +++++++++++-------- 5 files changed, 35 insertions(+), 13 deletions(-) diff --git a/ChangeLog b/ChangeLog index 7daeebe161..79821f90d5 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,14 @@ +2018-07-23 Werner LEMBERG + + doc: Avoid some overfull lines in the TeX output. + * doc/glibc-functions/futimesat.texi: Replace a long @code with a + @example. + * doc/pastposix-functions/pthread_attr_getstackaddr.texi: Insert a + newline before the long URL. + * doc/pastposix-functions/pthread_attr_setstackaddr.texi: Likewise. + * doc/relocatable-maint.texi: Use @smallexample instead of @example. + Add line breaks in code snippets. + 2018-07-17 Paul Eggert hard-locale: simplify by removing hard-locale.m4 diff --git a/doc/glibc-functions/futimesat.texi b/doc/glibc-functions/futimesat.texi index 73a9235f19..ac7bb615da 100644 --- a/doc/glibc-functions/futimesat.texi +++ b/doc/glibc-functions/futimesat.texi @@ -18,6 +18,11 @@ On some platforms, this function mis-handles trailing slash: Solaris 9. @item This function cannot set full timestamp resolution. Use -@code{file ? utimensat(fd,file,times,0) : futimens(fd,times)}, or the -gnulib module fdutimensat, instead. + +@example +file ? utimensat(fd, file, times, 0) + : futimens(fd, times) +@end example + +@noindent or the gnulib module fdutimensat, instead. @end itemize diff --git a/doc/pastposix-functions/pthread_attr_getstackaddr.texi b/doc/pastposix-functions/pthread_attr_getstackaddr.texi index a3cf1ac8a4..d0aaf42bda 100644 --- a/doc/pastposix-functions/pthread_attr_getstackaddr.texi +++ b/doc/pastposix-functions/pthread_attr_getstackaddr.texi @@ -2,7 +2,8 @@ @section @code{pthread_attr_getstackaddr} @findex pthread_attr_getstackaddr -POSIX specification: @url{http://www.opengroup.org/susv3xsh/pthread_attr_getstackaddr.html} +POSIX specification:@inlinefmt{tex,@*} +@url{http://www.opengroup.org/susv3xsh/pthread_attr_getstackaddr.html} Gnulib module: --- diff --git a/doc/pastposix-functions/pthread_attr_setstackaddr.texi b/doc/pastposix-functions/pthread_attr_setstackaddr.texi index 5c695abda1..9e6b588da3 100644 --- a/doc/pastposix-functions/pthread_attr_setstackaddr.texi +++ b/doc/pastposix-functions/pthread_attr_setstackaddr.texi @@ -2,7 +2,8 @@ @section @code{pthread_attr_setstackaddr} @findex pthread_attr_setstackaddr -POSIX specification: @url{http://www.opengroup.org/susv3xsh/pthread_attr_setstackaddr.html} +POSIX specification:@inlinefmt{tex,@*} +@url{http://www.opengroup.org/susv3xsh/pthread_attr_setstackaddr.html} Gnulib module: --- diff --git a/doc/relocatable-maint.texi b/doc/relocatable-maint.texi index 36cceb6223..d1e7090bc0 100644 --- a/doc/relocatable-maint.texi +++ b/doc/relocatable-maint.texi @@ -120,7 +120,7 @@ If your package installs shell scripts, also import the @code{relocatable-script} module. Then, near the beginning of each shell script that your package installs, add the following: -@example +@smallexample @@relocatable_sh@@ if test "@@RELOCATABLE@@" = yes; then exec_prefix="@@exec_prefix@@" @@ -142,7 +142,7 @@ fi # Get some relocated directory names. sysconfdir=`relocate "@@sysconfdir@@"` some_datadir=`relocate "@@datadir@@/something"` -@end example +@end smallexample You must adapt the definition of @code{orig_installdir}, depending on where the script gets installed. Also, at the end, instead of @@ -154,13 +154,16 @@ If your package installs Perl scripts, also import the @code{relocatable-perl} module. Then, near the beginning of each Perl script that your package installs, add the following: -@example +@smallexample @@relocatable_pl@@ if ("@@RELOCATABLE@@" eq "yes") @{ my $exec_prefix = "@@exec_prefix@@"; my $orig_installdir = "@@bindir@@"; # see Makefile.am's *_SCRIPTS variables - my ($orig_installprefix, $curr_installprefix) = find_prefixes($orig_installdir, find_curr_installdir()); - sub relocate @{ # the subroutine is defined whether or not the enclosing block is executed + my ($orig_installprefix, $curr_installprefix) = + find_prefixes($orig_installdir, find_curr_installdir()); + + # the subroutine is defined whether or not the enclosing block is executed + sub relocate @{ my ($dir) = @@_; if ("@@RELOCATABLE@@" eq "yes") @{ $dir =~ s%^$orig_installprefix/%$curr_installprefix/%; @@ -174,7 +177,7 @@ if ("@@RELOCATABLE@@" eq "yes") @{ # (The gnulib module 'configmake' can help with this.) $sysconfdir = relocate("@@sysconfdir@@"); $some_datadir = relocate(@@datadir@@/something"); -@end example +@end smallexample You must adapt the definition of @code{$orig_installdir}, depending on where the script gets installed. Also, at the end, instead of @@ -211,9 +214,10 @@ endif @code{SHLIBS_IN_BINDIR} is defined in @file{configure.ac} as follows: -@example -AM_CONDITIONAL([SHLIBS_IN_BINDIR], [case "$host_os" in mingw* | cygwin*) true;; *) false;; esac]) -@end example +@smallexample +AM_CONDITIONAL([SHLIBS_IN_BINDIR], + [case "$host_os" in mingw* | cygwin*) true;; *) false;; esac]) +@end smallexample @item You may also need to add a couple of variable assignments to your -- 2.39.5