Bug 67078

Summary: [patch] MFC of a rtld(1) man page is incomplete.
Product: Documentation Reporter: WATANABE Kazuhiro <CQG00620>
Component: Books & ArticlesAssignee: freebsd-doc (Nobody) <doc>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
file.diff none

Description WATANABE Kazuhiro 2004-05-23 14:00:42 UTC 
In a rtld(1) man page (revision 1.18.2.8, CVS tag is RELENG_4_10_BP),
there is a mistake of MFC.

How-To-Repeat: Run "man rtld" on FreeBSD 4.10-RC3.

| LD_PRELOAD       A list of shared libraries, separated by colons and/or
|                  white space, to be linked in before any other shared
|                  libraries.  If the directory is not specified then the
|                  directories specified by
| 
| LD_LIBMAP_DISABLE
|                  If set, disables the use of libmap.conf(5).
|                  LD_LIBRARY_PATH will be searched first followed by the
|                  set of built-in standard directories.  This is ignored
|                  for set-user-ID and set-group-ID programs.
Comment 1 Giorgos Keramidas 2004-06-08 10:17:36 UTC 
Shouldn't LD_LIBRARY_PATH be indented with .It too below?

> --- rtld.1.orig	Sun May 23 18:44:45 2004
> +++ rtld.1	Sun May 23 18:45:39 2004
> @@ -88,13 +88,13 @@
>  other shared libraries.
>  If the directory is not specified then
>  the directories specified by
> -.It Ev LD_LIBMAP_DISABLE
> -If set, disables the use of
> -.Xr libmap.conf 5 .
>  .Ev LD_LIBRARY_PATH
>  will be searched first
>  followed by the set of built-in standard directories.
>  This is ignored for set-user-ID and set-group-ID programs.
> +.It Ev LD_LIBMAP_DISABLE
> +If set, disables the use of
> +.Xr libmap.conf 5 .
>  .It Ev LD_BIND_NOW
>  When set to a nonempty string, causes
>  .Nm

By looking at the rest of the .Ev entries, I think the correct change
would just add an .It before ".Ev LD_LIBRARY_PATH".  The LD_xxx
environment vars seems to be alphabetically sorted, so moving
LD_LIBMAP_DISABLE *after* LD_LIBRARY_PATH would break the sorting.

- Giorgos
Comment 2 WATANABE Kazuhiro 2004-06-09 13:41:37 UTC 
At Tue, 8 Jun 2004 12:17:36 +0300,
George Keramidas wrote:
> Shouldn't LD_LIBRARY_PATH be indented with .It too below?
(snip)
> By looking at the rest of the .Ev entries, I think the correct change
> would just add an .It before ".Ev LD_LIBRARY_PATH".

I don't think so. Because in the -current's rtld(1) man page, this
part is described as below:

| .It Ev LD_PRELOAD
| A list of shared libraries, separated by colons and/or white space,
| to be linked in before any
| other shared libraries.
| If the directory is not specified then
| the directories specified by
| .Ev LD_LIBRARY_PATH
| will be searched first
| followed by the set of built-in standard directories.
| This is ignored for set-user-ID and set-group-ID programs.


> The LD_xxx
> environment vars seems to be alphabetically sorted, so moving
> LD_LIBMAP_DISABLE *after* LD_LIBRARY_PATH would break the sorting.

If we adjust the man page to the -current's one, LD_LIBMAP_DISABLE
should be placed before LD_PRELOAD (and my patch is wrong).
---
Watanabe Kazuhiro (CQG00620@nifty.ne.jp)
Comment 3 Remko Lodder freebsd_committer freebsd_triage 2006-08-30 11:26:12 UTC 
State Changed
From-To: open->closed

~ And now the end is near.  closed the PR with the argumentation 
of niclas (which i do support since our main scope is 5.X,6.X at the 
moment): 

I think pr docs/67078 can be closed. The pr mentions a MFC from Freebsd 5.2.1 
to FreeBSD 4.10-RC3 which has gone slightly wrong. Since RELENG_4 is pretty 
much at the end of things, and the change is already in all branches from 
RELENG_5, I think the issue is no more. 

Reported by:	Niclas Zeising on freebsd-doc