[defensive-coding-guide] 02/02: Fix build errors caused by
malformed includes
by pagure@pagure.io
This is an automated email from the git hooks/post-receive script.
pbokoc pushed a commit to branch master
in repository defensive-coding-guide.
commit 4d7432da07f178393f7f3bb9fcf8ba4bfcabbbcf
Author: Petr Bokoc <pbokoc(a)redhat.com>
AuthorDate: Tue Mar 17 23:25:21 2020 +0100
Fix build errors caused by malformed includes
---
modules/ROOT/pages/programming-languages/C-Language.adoc | 10 +++++-----
modules/ROOT/pages/programming-languages/C-Libc.adoc | 14 +++++++-------
modules/ROOT/pages/programming-languages/C.adoc | 8 ++++----
modules/ROOT/pages/programming-languages/CXX.adoc | 4 ++--
modules/ROOT/pages/programming-languages/Go.adoc | 4 ++--
.../ROOT/pages/programming-languages/Java-Language.adoc | 6 +++---
.../ROOT/pages/programming-languages/Java-LowLevel.adoc | 2 +-
.../pages/programming-languages/Java-SecurityManager.adoc | 8 ++++----
modules/ROOT/pages/programming-languages/Java.adoc | 6 +++---
modules/ROOT/pages/programming-languages/Shell.adoc | 2 +-
10 files changed, 32 insertions(+), 32 deletions(-)
diff --git a/modules/ROOT/pages/programming-languages/C-Language.adoc b/modules/ROOT/pages/programming-languages/C-Language.adoc
index de3d921..1f3907a 100644
--- a/modules/ROOT/pages/programming-languages/C-Language.adoc
+++ b/modules/ROOT/pages/programming-languages/C-Language.adoc
@@ -56,7 +56,7 @@ The cast silences a compiler warning;
[source,c]
----
-include::../snippets/C-Pointers-remaining.adoc[]
+include::partial$snippets/C-Pointers-remaining.adoc[]
----
@@ -86,7 +86,7 @@ see <<ex-Defensive_Coding-C-Arithmetic-bad>>.
[source,c]
----
-include::../snippets/C-Arithmetic-add.adoc[]
+include::partial$snippets/C-Arithmetic-add.adoc[]
----
@@ -113,7 +113,7 @@ additions have to be checked in this way.
[source,c]
----
-include::../snippets/C-Arithmetic-add_unsigned.adoc[]
+include::partial$snippets/C-Arithmetic-add_unsigned.adoc[]
----
====
@@ -129,7 +129,7 @@ see <<ex-Defensive_Coding-C-Arithmetic-mult>>.
[source,c]
----
-include::../snippets/C-Arithmetic-mult.adoc[]
+include::partial$snippets/C-Arithmetic-mult.adoc[]
----
====
@@ -189,7 +189,7 @@ after the `*`, and not before it.
[source,c]
----
-include::../snippets/C-Globals-String_Array.adoc[]
+include::partial$snippets/C-Globals-String_Array.adoc[]
----
diff --git a/modules/ROOT/pages/programming-languages/C-Libc.adoc b/modules/ROOT/pages/programming-languages/C-Libc.adoc
index 0e81f31..5e2375d 100644
--- a/modules/ROOT/pages/programming-languages/C-Libc.adoc
+++ b/modules/ROOT/pages/programming-languages/C-Libc.adoc
@@ -127,7 +127,7 @@ size is allocated on the heap, consider use
[source,c]
----
-include::../snippets/C-String-Functions-snprintf.adoc[]
+include::partial$snippets/C-String-Functions-snprintf.adoc[]
----
@@ -157,7 +157,7 @@ invariant. After the loop, the result string is in the
[source,c]
----
-include::../snippets/C-String-Functions-snprintf-incremental.adoc[]
+include::partial$snippets/C-String-Functions-snprintf-incremental.adoc[]
----
@@ -192,7 +192,7 @@ function (see <<ex-Defensive_Coding-C-String-Functions-format-Attribute>>).
[source,c]
----
-include::../snippets/C-String-Functions-format.adoc[]
+include::partial$snippets/C-String-Functions-format.adoc[]
----
@@ -207,7 +207,7 @@ ensuring NUL termination is:
[source,c]
----
-include::../snippets/C-String-Functions-strncpy.adoc[]
+include::partial$snippets/C-String-Functions-strncpy.adoc[]
----
@@ -216,7 +216,7 @@ function for this purpose:
[source,c]
----
-include::../snippets/C-String-Functions-strncat-as-strncpy.adoc[]
+include::partial$snippets/C-String-Functions-strncat-as-strncpy.adoc[]
----
@@ -239,7 +239,7 @@ approach similar to <<ex-Defensive_Coding-C-String-Functions-snprintf-incrementa
[source,c]
----
-include::../snippets/C-String-Functions-strncat-emulation.adoc[]
+include::partial$snippets/C-String-Functions-strncat-emulation.adoc[]
----
@@ -249,7 +249,7 @@ string:
[source,c]
----
-include::../snippets/C-String-Functions-strncat-merged.adoc[]
+include::partial$snippets/C-String-Functions-strncat-merged.adoc[]
----
diff --git a/modules/ROOT/pages/programming-languages/C.adoc b/modules/ROOT/pages/programming-languages/C.adoc
index 425780f..848d692 100644
--- a/modules/ROOT/pages/programming-languages/C.adoc
+++ b/modules/ROOT/pages/programming-languages/C.adoc
@@ -4,10 +4,10 @@
[[chap-Defensive_Coding-C]]
= The C Programming Language
-include::en-US/programming-languages/C-Language.adoc[]
+include::C-Language.adoc[]
-include::en-US/programming-languages/C-Libc.adoc[]
+include::C-Libc.adoc[]
-include::en-US/programming-languages/C-Allocators.adoc[]
+include::C-Allocators.adoc[]
-include::en-US/programming-languages/C-Other.adoc[]
+include::C-Other.adoc[]
diff --git a/modules/ROOT/pages/programming-languages/CXX.adoc b/modules/ROOT/pages/programming-languages/CXX.adoc
index 4268fe8..7f963b7 100644
--- a/modules/ROOT/pages/programming-languages/CXX.adoc
+++ b/modules/ROOT/pages/programming-languages/CXX.adoc
@@ -3,6 +3,6 @@
[[chap-Defensive_Coding-CXX]]
= The C++ Programming Language
-include::en-US/programming-languages/CXX-Language.adoc[]
+include::CXX-Language.adoc[]
-include::en-US/programming-languages/CXX-Std.adoc[]
+include::CXX-Std.adoc[]
diff --git a/modules/ROOT/pages/programming-languages/Go.adoc b/modules/ROOT/pages/programming-languages/Go.adoc
index 6059cff..368e1ba 100644
--- a/modules/ROOT/pages/programming-languages/Go.adoc
+++ b/modules/ROOT/pages/programming-languages/Go.adoc
@@ -53,7 +53,7 @@ details.
[source,go]
----
-include::../snippets/Go-Error_Handling-Regular.adoc[]
+include::partial$snippets/Go-Error_Handling-Regular.adoc[]
----
@@ -73,7 +73,7 @@ returning both data and an error at the same time.
[source,go]
----
-include::../snippets/Go-Error_Handling-IO.adoc[]
+include::partial$snippets/Go-Error_Handling-IO.adoc[]
----
diff --git a/modules/ROOT/pages/programming-languages/Java-Language.adoc b/modules/ROOT/pages/programming-languages/Java-Language.adoc
index effa572..d882b85 100644
--- a/modules/ROOT/pages/programming-languages/Java-Language.adoc
+++ b/modules/ROOT/pages/programming-languages/Java-Language.adoc
@@ -31,7 +31,7 @@ data, implementing an exponential growth policy. See the
[source,java]
----
-include::../snippets/Java-Language-ReadArray.adoc[]
+include::partial$snippets/Java-Language-ReadArray.adoc[]
----
@@ -62,7 +62,7 @@ possible and should not throw any exceptions.
[source,java]
----
-include::../snippets/Java-Finally.adoc[]
+include::partial$snippets/Java-Finally.adoc[]
----
@@ -87,7 +87,7 @@ used instead. The Java compiler will automatically insert the
[source,java]
----
-include::../snippets/Java-TryWithResource.adoc[]
+include::partial$snippets/Java-TryWithResource.adoc[]
----
diff --git a/modules/ROOT/pages/programming-languages/Java-LowLevel.adoc b/modules/ROOT/pages/programming-languages/Java-LowLevel.adoc
index ffc9399..a5b7d9d 100644
--- a/modules/ROOT/pages/programming-languages/Java-LowLevel.adoc
+++ b/modules/ROOT/pages/programming-languages/Java-LowLevel.adoc
@@ -75,7 +75,7 @@ beginning of the array.
[source,java]
----
-include::../snippets/Java-JNI-Pointers.adoc[]
+include::partial$snippets/Java-JNI-Pointers.adoc[]
----
diff --git a/modules/ROOT/pages/programming-languages/Java-SecurityManager.adoc b/modules/ROOT/pages/programming-languages/Java-SecurityManager.adoc
index bb1cd66..17b7933 100644
--- a/modules/ROOT/pages/programming-languages/Java-SecurityManager.adoc
+++ b/modules/ROOT/pages/programming-languages/Java-SecurityManager.adoc
@@ -110,7 +110,7 @@ shows how to run a piece code of with reduced privileges.
[source,java]
----
-include::../snippets/Java-SecurityManager-Unprivileged.adoc[]
+include::partial$snippets/Java-SecurityManager-Unprivileged.adoc[]
----
@@ -123,7 +123,7 @@ on all files in the current directory) can be used:
[source,java]
----
-include::../snippets/Java-SecurityManager-CurrentDirectory.adoc[]
+include::partial$snippets/Java-SecurityManager-CurrentDirectory.adoc[]
----
@@ -208,7 +208,7 @@ shows how to request additional privileges.
[source,java]
----
-include::../snippets/Java-SecurityManager-Privileged.adoc[]
+include::partial$snippets/Java-SecurityManager-Privileged.adoc[]
----
@@ -249,7 +249,7 @@ invocation out of the privileged code section, of course.)
[source,java]
----
-include::../snippets/Java-SecurityManager-Callback.adoc[]
+include::partial$snippets/Java-SecurityManager-Callback.adoc[]
----
diff --git a/modules/ROOT/pages/programming-languages/Java.adoc b/modules/ROOT/pages/programming-languages/Java.adoc
index fef5fdb..5c9e9a7 100644
--- a/modules/ROOT/pages/programming-languages/Java.adoc
+++ b/modules/ROOT/pages/programming-languages/Java.adoc
@@ -4,8 +4,8 @@
[[chap-Defensive_Coding-Java]]
= The Java Programming Language
-include::en-US/programming-languages/Java-Language.adoc[]
+include::Java-Language.adoc[]
-include::en-US/programming-languages/Java-LowLevel.adoc[]
+include::Java-LowLevel.adoc[]
-include::en-US/programming-languages/Java-SecurityManager.adoc[]
+include::Java-SecurityManager.adoc[]
diff --git a/modules/ROOT/pages/programming-languages/Shell.adoc b/modules/ROOT/pages/programming-languages/Shell.adoc
index 9395d82..8362485 100644
--- a/modules/ROOT/pages/programming-languages/Shell.adoc
+++ b/modules/ROOT/pages/programming-languages/Shell.adoc
@@ -350,7 +350,7 @@ POSIX shells.
[source,bash]
----
-include::../snippets/Shell-Input_Validation.adoc[]
+include::partial$snippets/Shell-Input_Validation.adoc[]
----
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
3 years, 6 months
[defensive-coding-guide] 01/02: Update build & preview scripts
by pagure@pagure.io
This is an automated email from the git hooks/post-receive script.
pbokoc pushed a commit to branch master
in repository defensive-coding-guide.
commit a545203c03572ad1210575fd55c8e04c79dad023
Author: Petr Bokoc <pbokoc(a)redhat.com>
AuthorDate: Tue Mar 17 23:16:07 2020 +0100
Update build & preview scripts
---
build.sh | 40 +++++++++++++++++++++++++++++++++++-----
preview.sh | 10 +++++-----
2 files changed, 40 insertions(+), 10 deletions(-)
diff --git a/build.sh b/build.sh
index c9349e3..1e4db2d 100755
--- a/build.sh
+++ b/build.sh
@@ -1,16 +1,46 @@
#!/bin/sh
+image="docker.io/antora/antora"
+cmd="--html-url-extension-style=indexify site.yml"
+
if [ "$(uname)" == "Darwin" ]; then
# Running on macOS.
# Let's assume that the user has the Docker CE installed
# which doesn't require a root password.
- docker run --rm -it -v $(pwd):/antora antora/antora --html-url-extension-style=indexify site.yml
+ echo ""
+ echo "This build script is using Docker container runtime to run the build in an isolated environment."
+ echo ""
+ docker run --rm -it -v $(pwd):/antora $image $cmd
elif [ "$(expr substr $(uname -s) 1 5)" == "Linux" ]; then
# Running on Linux.
- # Let's assume that it's running the Docker deamon
+ # Check whether podman is available, else faill back to docker
# which requires root.
- echo ""
- echo "This build script is using Docker to run the build in an isolated environment. You might be asked for a root password in order to start it."
-sudo docker run --rm -it -v $(pwd):/antora:z antora/antora --html-url-extension-style=indexify site.yml
+
+ if [ -f /usr/bin/podman ]; then
+ echo ""
+ echo "This build script is using Podman to run the build in an isolated environment."
+ echo ""
+ podman run --rm -it -v $(pwd):/antora:z $image $cmd
+
+ elif [ -f /usr/bin/docker ]; then
+ echo ""
+ echo "This build script is using Docker to run the build in an isolated environment."
+ echo ""
+
+ if groups | grep -wq "docker"; then
+ docker run --rm -it -v $(pwd):/antora:z $image $cmd
+ else
+ echo ""
+ echo "This build script is using $runtime to run the build in an isolated environment. You might be asked for your password."
+ echo "You can avoid this by adding your user to the 'docker' group, but be aware of the security implications. See https://docs.docker.com/install/linux/linux-postinstall/."
+ echo ""
+ sudo docker run --rm -it -v $(pwd):/antora:z $image $cmd
+ fi
+ else
+ echo ""
+ echo "Error: Container runtime haven't been found on your system. Fix it by:"
+ echo "$ sudo dnf install podman"
+ exit 1
+ fi
fi
diff --git a/preview.sh b/preview.sh
index c2fcc4b..acc52af 100755
--- a/preview.sh
+++ b/preview.sh
@@ -9,10 +9,10 @@ if [ "$(uname)" == "Darwin" ]; then
elif [ "$(expr substr $(uname -s) 1 5)" == "Linux" ]; then
# Running on Linux.
- # Let's assume that it's running the Docker deamon
- # which requires root.
+ # Fedora Workstation has python3 installed as a default, so using that
echo ""
- echo "This build script is using Docker to run the build in an isolated environment. You might be asked for a root password in order to start it."
- echo "The preview will be available at http://localhost:8080/"
- sudo docker run --rm -v $(pwd):/antora:ro,z -v $(pwd)/nginx.conf:/etc/nginx/conf.d/default.conf:ro,z -p 8080:80 nginx
+ echo "The preview is available at http://localhost:8080"
+ echo ""
+ cd ./public
+ python3 -m http.server 8080
fi
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
3 years, 6 months