CLEANUP: Prevent channel-t.h from being detected as C++ by GitHub
authorTim Duesterhus <tim@bastelstu.be>
Sat, 19 Jun 2021 14:56:30 +0000 (16:56 +0200)
committerWilly Tarreau <w@1wt.eu>
Sun, 20 Jun 2021 09:46:26 +0000 (11:46 +0200)
commit7386668cbf7eba555d8b421f4360e9d4541c7e99
treeabe6d74954453a17fe202614646a02b0af102d6b
parent901972e261da6747aff7ea2ebbd0f35aec6a8a08
CLEANUP: Prevent channel-t.h from being detected as C++ by GitHub

GitHub uses github/linguist to determine the programming language used for each
source file to show statistics and to power the search. In cases of unique file
extensions this is easy, but for `.h` files the situation is less clear as they
are used for C, C++, Objective C and more. In these cases linguist makes use of
heuristics to determine the language.

One of these heuristics for C++ is that the file contains a line beginning with
`try`, only preceded by whitespace indentation. This heuristic matches the long
comment at the bottom of `channel-t.h`, as one sentence includes the word `try`
after a linebreak.

Fix this misdetection by changing the comment to follow the convention that all
lines start with an asterisk.
include/haproxy/channel-t.h