Skip to content

Commit

Permalink
devonfw#961: fixed function doc
Browse files Browse the repository at this point in the history
  • Loading branch information
hohwille committed Oct 25, 2022
1 parent 061a70b commit 1890148
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
6 changes: 6 additions & 0 deletions documentation/functions.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,12 @@ If this does not happen, the name is determined from the URL.
If the file exists and the force option was not specified, the function ends with a corresponding message and the return value 255.
Otherwise the file is downloaded and, if successful, moved to the target directory.

=== doEnvironmentProject
Loads all `devon.properties` via xref:doLoadProperties[].
If the first argument is not empty (set to `export`) it will export all the properties.
Also it sets the environment variables `DEVON_HOME_DIR`, `WORKSPACE`, and `WORKSPACE_PATH`.
Finally, it updates the `PATH` variable via xref:doUpdatePath[] and exports it.

=== doExtract
Takes the file to be extracted and possibly a path to where it should be extracted.
Then the right tool is selected based on the file extension and the file is unzipped.
Expand Down
2 changes: 1 addition & 1 deletion scripts/src/test/bash/test-functions-doc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/bin/bash

SCRIPTS_PATH="../../../../scripts/src/main/resources/scripts"
( set -o pipefail; grep "function " "${SCRIPTS_PATH}/functions" "${SCRIPTS_PATH}/environment-project" | sed 's/.*function //' | sed 's/() {//' | sort -u > functions.list ) || exit 1
( set -o pipefail; grep "function " "${SCRIPTS_PATH}/functions" "${SCRIPTS_PATH}/functions-core" | sed 's/.*function //' | sed 's/() {//' | sort -u > functions.list ) || exit 1
( set -o pipefail; grep "=== " "../../../../documentation/functions.asciidoc" | sed 's/=== //' | sort -u > functions.adoc.list ) || exit 1

diff functions.list functions.adoc.list
Expand Down

0 comments on commit 1890148

Please sign in to comment.