]> git.ipfire.org Git - thirdparty/binutils-gdb.git/commit
doc: sframe: small improvements for readability
authorIndu Bhagat <indu.bhagat@oracle.com>
Wed, 26 Jun 2024 05:27:12 +0000 (22:27 -0700)
committerIndu Bhagat <indu.bhagat@oracle.com>
Wed, 26 Jun 2024 05:27:12 +0000 (22:27 -0700)
commitf8ed9c5722d465f5a3dd5c6cb5616e3d92014727
treeef7b5dd0f553ddc1a3cd4301820ed5db39aa1975
parentb57ce132426f18ee2dbfe7b220089da397c1c0ce
doc: sframe: small improvements for readability

Update some of the content to make the specification document hopefully
clearer:
  - Fix some typos.
  - Use Title case consistently for headings.
  - Update text around detection of foreign endianness.
  - Split the structure field "Name" in each table to two separate
    colunms for additional attention: "Type" and "Name".
  - Rename "SFrame endianness" section to "SFrame magic number and
    endianness"
  - Update text around provisions for extending SFrame for future
    ABIs/architectures.  Make it clear by tagging all provisions with an
    explicit index item "Provisions for future ABIs".
  - Add a paragraph on sort order of SFrame FDEs.
  - Add a statement for SFRAME_F_FRAME_POINTER flag.
  - Add a statement to assert that SFrame version 1 is now obsolete and
    should not be used.

libsframe/
* doc/sframe-spec.texi: Small improvements for readability.
libsframe/doc/sframe-spec.texi