objcopy: Mention 'entry address' in description

Message ID 20200505145436.4048003-1-andrew.burgess@embecosm.com
State New
Headers show
Series
  • objcopy: Mention 'entry address' in description
Related show

Commit Message

Andrew Burgess May 5, 2020, 2:54 p.m.
The ELF header contains a start address, which is also sometimes
called the entry address.  The 'objdump -x' output calls this field
the 'start address', while readelf calls it 'entry point address'.
The linker talks about setting the 'entry' point in its manual.

I've always thought of this field as the 'entry address', and so when
I recently wanted to know if objcopy could adjust this field I opened
up the manual and searched for 'entry', which found no hits.

I thought it would be useful (for people like me) if the description
of 'set-start' and 'adjust-start' in the objcopy manual mentioned the
word 'entry' to make it easier to find.

binutils/ChangeLog:

	* doc/binutils.texi: Mention 'entry address' in the set-start and
	adjust-start options descriptions.
---
 binutils/ChangeLog         |  5 +++++
 binutils/doc/binutils.texi | 10 ++++++----
 2 files changed, 11 insertions(+), 4 deletions(-)

-- 
2.25.3

Comments

David Faust via Binutils May 7, 2020, 9:51 a.m. | #1
Hi Andrew,

> binutils/ChangeLog:

> 

> 	* doc/binutils.texi: Mention 'entry address' in the set-start and

> 	adjust-start options descriptions.


Approved - please apply.

Cheers
  Nick

Patch

diff --git a/binutils/doc/binutils.texi b/binutils/doc/binutils.texi
index 9a3a40f1476..3c8a50b5d98 100644
--- a/binutils/doc/binutils.texi
+++ b/binutils/doc/binutils.texi
@@ -1568,14 +1568,16 @@ 
 filled in with the value specified by @option{--gap-fill} (default zero).
 
 @item --set-start @var{val}
-Set the start address of the new file to @var{val}.  Not all object file
-formats support setting the start address.
+Set the start address (also known as the entry address) of the new
+file to @var{val}.  Not all object file formats support setting the
+start address.
 
 @item --change-start @var{incr}
 @itemx --adjust-start @var{incr}
 @cindex changing start address
-Change the start address by adding @var{incr}.  Not all object file
-formats support setting the start address.
+Change the start address (also known as the entry address) by adding
+@var{incr}.  Not all object file formats support setting the start
+address.
 
 @item --change-addresses @var{incr}
 @itemx --adjust-vma @var{incr}