fortify-headers

commit 36d7b9197c4863c9a0113512bb566a2ee0b5d72d
parent 58226077c22cef573ad148abca77b23e96a1b2f8
Author: jvoisin <julien.voisin@dustri.org>
Date:   Fri,  8 Dec 2023 18:41:35 +0100

Add a check in the CI to keep the readme up to date

Diffstat:
A
.github/workflows/documentation.yaml
 | 
18
++++++++++++++++++
M
README.md
 | 
18
++++++++++++++++++

2 files changed, 36 insertions(+), 0 deletions(-)
diff --git a/.github/workflows/documentation.yaml b/.github/workflows/documentation.yaml
@@ -0,0 +1,18 @@
+name: Check that the README is up to date
+
+on:
+  pull_request:
+  push:
+
+jobs:
+  latest:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checking out the code
+        uses: actions/checkout@v3
+      - run: |
+          for function in $(find include/ -type f -exec sed -n 's/^_FORTIFY_FN(\([^)]\+\)).*/\1/p' '{}' ';' | sort | uniq)
+          do
+          	grep "\`$function\`" README.md || (echo "Please add \`$function\` to the README.md file." && exit 1)
+          done
+
diff --git a/README.md b/README.md
@@ -59,9 +59,14 @@ At this point, the program will safely crash.
 - `FD_SET`
 - `bcopy`
 - `bzero`
+- `calloc`
 - `confstr`
+- `fdopen` 
 - `fgets`
 - `fgetws`
+- `fmemopen` 
+- `fopen` 
+- `fprintf` 
 - `fread`
 - `fwrite`
 - `getcwd`
@@ -69,22 +74,31 @@ At this point, the program will safely crash.
 - `getgroups`
 - `gethostname`
 - `getlogin_r`
+- `malloc` 
 - `mbsnrtowcs`
 - `mbsrtowcs`
 - `mbstowcs`
+- `memchr` 
 - `memcpy`
 - `memmove`
 - `mempcpy`
 - `memset`
 - `poll`
+- `popen` 
 - `ppoll`
 - `pread`
+- `printf` 
+- `pwrite` 
+- `qsort` 
 - `read`
 - `readlink`
 - `readlinkat`
+- `realloc` 
+- `reallocarray` 
 - `realpath`
 - `recv`
 - `recvfrom`
+- `select` 
 - `send`
 - `sendto`
 - `snprintf`
@@ -100,7 +114,11 @@ At this point, the program will safely crash.
 - `strncat`
 - `strncpy`
 - `strrchr`
+- `tmpfile` 
 - `ttyname_r`
+- `umask` 
+- `vfprintf` 
+- `vprintf` 
 - `vsnprintf`
 - `vsprintf`
 - `wcrtomb`