From: Mark Wielaard Date: Fri, 27 Jul 2018 12:43:15 +0000 (+0200) Subject: libelf: Fix documentation of elf_getshdrstrndx and elf_getshstrndx. X-Git-Tag: elfutils-0.174~18 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=7df3138246193c5d72b53fe789457114ecf071cb;p=thirdparty%2Felfutils.git libelf: Fix documentation of elf_getshdrstrndx and elf_getshstrndx. Because of copy/paste error part of the documentation for elf_getshdrstrndx and elf_getshstrndx was actually for elf_getshdrnum and elf_getshnum. Fix it to refer to the proper ehdr field and deprecated function name. Signed-off-by: Mark Wielaard --- diff --git a/libelf/ChangeLog b/libelf/ChangeLog index 91d9b4726..744c5b4db 100644 --- a/libelf/ChangeLog +++ b/libelf/ChangeLog @@ -1,3 +1,8 @@ +2018-07-27 Mark Wielaard + + * libelf.h (elf_getshdrstrndx): Fix documentation. + (elf_getshstrndx): Likewise. + 2018-06-19 Mark Wielaard * libelfP.h (__libelf_type_align): Remove !ALLOW_UNALIGNED guard. diff --git a/libelf/libelf.h b/libelf/libelf.h index 547c0f508..61f192312 100644 --- a/libelf/libelf.h +++ b/libelf/libelf.h @@ -310,13 +310,13 @@ extern int elf_getshnum (Elf *__elf, size_t *__dst) /* Get the section index of the section header string table in the ELF - file. If the index cannot be represented in the e_shnum field of + file. If the index cannot be represented in the e_shstrndx field of the ELF header the information from the sh_link field in the zeroth section header is used. */ extern int elf_getshdrstrndx (Elf *__elf, size_t *__dst); -/* Sun messed up the implementation of 'elf_getshnum' in their implementation. - It was agreed to make the same functionality available under a different - name and obsolete the old name. */ +/* Sun messed up the implementation of 'elf_getshstrndx' in their + implementation. It was agreed to make the same functionality available + under a different name and obsolete the old name. */ extern int elf_getshstrndx (Elf *__elf, size_t *__dst) __deprecated_attribute__;