Document purpose of each ld statement lists
authorThomas Preud'homme <thomas.preudhomme@linaro.org>
Thu, 29 Nov 2018 13:42:49 +0000 (13:42 +0000)
committerThomas Preud'homme <thomas.preudhomme@linaro.org>
Thu, 29 Nov 2018 13:42:49 +0000 (13:42 +0000)
commite368bf56d38afecd1ac0e19c9e9cb54e2bb4fad2
tree6f6722810ab9e256011fb87e10bded218d8fb329
parentffd9e4d0225d45d1603d09e06151c388589e063f
Document purpose of each ld statement lists

When discovering the statement lists via their header variable
statement_list, file_chain and input_file_chain it can be confusing to
figure out what they are for. They can point to the same initial
statement and the relation between the next field they use is not
obvious from the name.

This commit adds comment for each of those statement list header to
explain what they are for and what next field they use. It also rewrite
the comment for the next fields to simply redirect the reader to the
list header to avoid duplication of documentation.

2018-11-29  Thomas Preud'homme  <thomas.preudhomme@linaro.org>

ld/
* ldlang.c (statement_list): Document purpose and what next field it
uses.
(file_chain): Likewise.
(input_file_chain): Likewise.
* ldlang.h (lang_statement_header_type): Document statement list header
the next pointer correspond to.
(lang_statement_header_type): Replace comment for next and
next_real_file field to refer the reader to their corresponding
statement list header.
ld/ChangeLog
ld/ldlang.c
ld/ldlang.h