RISC-V: Comments tidy and improvement.
authorNelson Chu <nelson.chu@sifive.com>
Wed, 13 Jan 2021 02:05:48 +0000 (10:05 +0800)
committerNelson Chu <nelson.chu@sifive.com>
Fri, 15 Jan 2021 09:28:07 +0000 (17:28 +0800)
commitdcd709e056c6f4b7ffff759b9b6ecab1177083ed
tree57ecb316b9099ab4d0be806f9c0ab281816801f7
parentbb3eddb5bd60b56cf19a0aacfd6b56a1b32d21a7
RISC-V: Comments tidy and improvement.

The GNU coding standards said the comments should be complete sentences
and end with a period and two spaces.  But sometimes it should be more
cleaner when the comments only include a word or codes.  Therefore, I made
the following changes after referring to other target/generic codes,

* Try to write sentences in comments, must end with a period and two spaces.
* End with two spaces without a period for codes/instructions only.
* End with one space without a period for a single word/variable only.

Besids, also rewrite/remove some comments which are obsolete or too long,
and fix indents for comments.

bfd/
    * elfnn-riscv.c: Comments tidy and improvement.
    * elfxx-riscv.c: Likewise.
    * elfxx-riscv.h: Likewise.
gas/
    * config/tc-riscv.c: Comments tidy and improvement.  Also update
    comment "fallthru" to "Fall through" that end with a period and
    two spaces.
include/
    * elf/riscv.h: Comments tidy and improvement.
    * opcode/riscv-opc.h: Likewise.
    * opcode/riscv.h: Likewise.
opcodes/
    * riscv-dis.c: Comments tidy and improvement.
    * riscv-opc.c: Likewise.
13 files changed:
bfd/ChangeLog
bfd/elfnn-riscv.c
bfd/elfxx-riscv.c
bfd/elfxx-riscv.h
gas/ChangeLog
gas/config/tc-riscv.c
include/ChangeLog
include/elf/riscv.h
include/opcode/riscv-opc.h
include/opcode/riscv.h
opcodes/ChangeLog
opcodes/riscv-dis.c
opcodes/riscv-opc.c