doc: remove obsolete line from doccheck#7217
Conversation
OlegHahm
added
Area: doc
|
|
||
| RIOTBASE=$(readlink -f "$(dirname $(realpath $0))/../../..") | ||
|
|
||
| ERRORS=$(make doc 2>&1 | grep '.*warning' | sed "s#${PWD}/\([^:]*\)#\1#g") |
There was a problem hiding this comment.
Shouldn't RIOTBASE rather be used in this line?
make -C "${RIOTBASE}" doc 2>&1 ....
There was a problem hiding this comment.
Shouldn't make a difference: make doc can only be called from ${RIOTBASE} anyway.
There was a problem hiding this comment.
Yes, but if you call this script from any other location than ${RIOTBASE} it will succeed as a false positive (without actually executing doxygen).
There was a problem hiding this comment.
Ping @OlegHahm? Scripts you have to call from a certain directory suck IMHO ;-)
|
ping @OlegHahm |
|
@OlegHahm I don't remember the context of this PR, but the line doesn't look obsolete to me. Can you maybe update the description with your reasoning. Regardless, I think the following patch would work much better, as you won't get false positives for this script from any directory: diff --git a/dist/tools/doccheck/check.sh b/dist/tools/doccheck/check.sh
index ef618fb..f5aa09c 100755
--- a/dist/tools/doccheck/check.sh
+++ b/dist/tools/doccheck/check.sh
@@ -8,7 +8,7 @@
RIOTBASE=$(readlink -f "$(dirname $(realpath $0))/../../..")
-ERRORS=$(make doc 2>&1 | grep '.*warning' | sed "s#${PWD}/\([^:]*\)#\1#g")
+ERRORS=$(make -C "${RIOTBASE}" doc 2>&1 | grep '.*warning' | sed "s#${PWD}/\([^:]*\)#\1#g")
if [ -n "${ERRORS}" ]
then |
|
@miri64 your patch would allow to call doccheck script from anywhere not just from RIOTBASE, right? |
The doccheck script reports reports a false positive when executed from any directory but `RIOTBASE`. With this fix, `make doc` changes into the currently unused `RIOTBASE` variable. This is an alternative approach to RIOT-OS#7217, which removes this variable, but keeps the false positive aspect of the script untouched.
|
#8220 has been merged |
The doccheck script reports reports a false positive when executed from any directory but `RIOTBASE`. With this fix, `make doc` changes into the currently unused `RIOTBASE` variable. This is an alternative approach to RIOT-OS#7217, which removes this variable, but keeps the false positive aspect of the script untouched.
The doccheck script reports reports a false positive when executed from any directory but `RIOTBASE`. With this fix, `make doc` changes into the currently unused `RIOTBASE` variable. This is an alternative approach to RIOT-OS#7217, which removes this variable, but keeps the false positive aspect of the script untouched.
4 participants
No description provided.