d/freebsd-nq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Consistently use the word 'flag' to refer to ELF_F_* constants.

Browse Source 
MFC after:	1 day
This commit is contained in:
Joseph Koshy 2007-10-22 03:38:43 +00:00
parent e41966dc35
commit a3347b3e74
5 changed files with 19 additions and 19 deletions

18
lib/libelf/elf_flagdata.3

@ -1,4 +1,4 @@
.\" Copyright (c) 2006 Joseph Koshy. All rights reserved.
.\" Copyright (c) 2006,2007 Joseph Koshy. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
@ -23,7 +23,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd August 10, 2006
.Dd October 22, 2007
.Os
.Dt ELF_FLAGDATA 3
.Sh NAME
@ -51,7 +51,7 @@
.Ft "unsigned int"
.Fn elf_flagshdr "Elf_Scn *scn" "Elf_Cmd cmd" "unsigned int flags"
.Sh DESCRIPTION
These functions are used to query, set or reset flag bits on data
These functions are used to query, set or reset flags on data
structures associated with an ELF file.
.Pp
Arguments
@ -59,7 +59,7 @@ Arguments
.Ar elf
and
.Ar scn
denote the data structures whose status bits need to be changed.
denote the data structures whose flags need to be changed.
These values are allowed to be NULL to simplify error handling in
application code.
.Pp
@ -70,16 +70,16 @@ may have the following values:
.It Dv ELF_C_CLR
The argument
.Ar flags
specifies the bits to be cleared.
specifies the flags to be cleared.
.It Dv ELF_C_SET
The argument
.Ar flags
specifies the bits to be set.
specifies the flags to be set.
.El
.Pp
The argument
.Ar flags
is allowed to have the following bits set:
is allowed to have the following flags set:
.Bl -tag -width ELF_F_LAYOUT
.It Dv ELF_F_DIRTY
Mark the associated data structure as needing to be written back
@ -111,7 +111,7 @@ Using a value of zero for argument
will return the current set of flags for the data structure being
queried.
.Sh RETURN VALUES
These functions return the updated bits is successful, and zero if
These functions return the updated flags is successful, and zero if
an error is detected.
.Sh ERRORS
These functions may fail with the following errors:
@ -123,7 +123,7 @@ argument.
.It Bq Er ELF_E_ARGUMENT
Argument
.Ar flags
had unsupported flag bits set.
had unsupported flags set.
.It Bq Er ELF_E_ARGUMENT
The argument
.Ar elf

6
lib/libelf/elf_getscn.3

@ -1,4 +1,4 @@
.\" Copyright (c) 2006 Joseph Koshy. All rights reserved.
.\" Copyright (c) 2006,2007 Joseph Koshy. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
@ -23,7 +23,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd August 26, 2006
.Dd October 22, 2007
.Os
.Dt ELF_GETSCN 3
.Sh NAME
@ -73,7 +73,7 @@ field of the ELF header associated with descriptor
.Ar elf ,
and will set the
.Dv ELF_F_DIRTY
bit for the new section.
flag on the returned section descriptor.
For ELF descriptors opened for writing, the ELF library will
automatically create an empty section at index zero
.Dv ( SHN_UNDEF )

4
lib/libelf/elf_update.3

@ -23,7 +23,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd September 08, 2007
.Dd October 22, 2007
.Os
.Dt ELF_UPDATE 3
.Sh NAME
@ -63,7 +63,7 @@ If the
.Dv ELF_F_LAYOUT
flag has been set on the ELF descriptor, the application assumes full
responsibility for the layout of the ELF object.
If this bit is not set, the ELF library will compute the layout of the
If this flag is not set, the ELF library will compute the layout of the
file from its associated section descriptors.
.Pp
It is the application's responsibility to manage the the following

6
lib/libelf/gelf_newehdr.3

@ -1,4 +1,4 @@
.\" Copyright (c) 2006 Joseph Koshy. All rights reserved.
.\" Copyright (c) 2006,2007 Joseph Koshy. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
@ -23,7 +23,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd December 16, 2006
.Dd October 22, 2007
.Os
.Dt GELF_NEWEHDR 3
.Sh NAME
@ -122,7 +122,7 @@ as needed before calling
.Pp
If successful, these three functions set the
.Dv ELF_F_DIRTY
bit on ELF descriptor
flag on ELF descriptor
.Ar elf .
.Sh RETURN VALUES
These functions return a pointer to a translated header descriptor

4
lib/libelf/gelf_newphdr.3

@ -23,7 +23,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd October 21, 2007
.Dd October 22, 2007
.Os
.Dt GELF_NEWPHDR 3
.Sh NAME
@ -82,7 +82,7 @@ elements depending on the ELF class of ELF descriptor
.Pp
The functions set the
.Dv ELF_F_DIRTY
bit on the program header table.
flag on the program header table.
All members of the returned array of Phdr structures
will be initialized to zero.
.Pp