doc: Fix typos in endif header comments #23524

1. 
   MarcoFalke commented at 8:51 am on November 16, 2021: member

   Some of the endif header comments have typos in them (ZMRRPC_H), or are from a different file, or are inconsistently formatted.

   Fix all and adjust the linter.

2. MarcoFalke added the label Docs on Nov 16, 2021
3. doc: Fix typos in endif header comments fa44237d76
4. MarcoFalke force-pushed on Nov 16, 2021
5. 
   katesalazar commented at 9:08 am on November 16, 2021: contributor

   Concept ACK.
6. hebasto approved
7. 
   hebasto commented at 10:47 am on November 16, 2021: member

   ACK fa44237d76b66b6664870c3927b65a0ef89022e4

   I’ve reviewed changes in test/lint/lint-include-guards.sh, and verified that all other changes are actually forced by the updated linter.

8. shaavan approved
9. 
   shaavan commented at 12:26 pm on November 16, 2021: contributor

   ACK fa44237d76b66b6664870c3927b65a0ef89022e4

   The updated lint-include-guard test makes sure that all three keywords: “ifndef”, “define”, “endif //”, must be present for each header file. This also ensures there are no redundant inundation or whitespaces on the lines in which they are present.

   I have tested that the updated test is working correctly in following cases:

   1. In case extra space is added anywhere on the line (beginning or in the middle)
   2. Space is removed between “//” and includes guard name.
   3. “//” is changed.

   However, it cannot detect if an extra line is added above or below these keywords.

   0+
   1 #endif // BITCOIN_LIBSECP256K1_CONFIG_H
   

   Though that’s not the case, this test is designed to handle, so it is not an issue.

10. 
    MarcoFalke commented at 12:32 pm on November 16, 2021: member

    Though that’s not the case, this test is designed to handle, so it is not an issue.

    Correct

11. fanquake merged this on Nov 17, 2021
12. fanquake closed this on Nov 17, 2021

    ---

13. MarcoFalke deleted the branch on Nov 17, 2021
14. sidhujag referenced this in commit bce0f0a20b on Nov 17, 2021
15. DrahtBot locked this on Nov 17, 2022

Contributors
MarcoFalke katesalazar hebasto shaavan

Labels
Docs