Updated the manuals

This commit is contained in:
Markus Fleschutz
2024-03-27 17:36:59 +01:00
parent c5b5cb1c6e
commit aed2b7d940
610 changed files with 1754 additions and 1120 deletions

View File

@ -9,7 +9,7 @@ Parameters
PS> ./build-repo.ps1 [[-path] <String>] [<CommonParameters>]
-path <String>
Specifies the path to the Git repository (current working dir by default)
Specifies the path to the Git repository (default is current working directory)
Required? false
Position? 1
@ -26,9 +26,9 @@ Example
-------
```powershell
PS> ./build-repo.ps1 C:\Repos\ninja
Building 📂ninja using CMakeLists.txt into 📂ninja/_My_Build...
Building 📂ninja using CMakeLists.txt into 📂ninja/_Build_Results...
...
Built 📂ninja in 47 sec
Built 📂ninja repository in 47 sec.
```
@ -49,12 +49,12 @@ Script Content
.DESCRIPTION
This PowerShell script builds a Git repository by supporting build systems such as: autogen, cmake, configure, Gradle, Imakefile, Makefile, and Meson.
.PARAMETER path
Specifies the path to the Git repository (current working dir by default)
Specifies the path to the Git repository (default is current working directory)
.EXAMPLE
PS> ./build-repo.ps1 C:\Repos\ninja
⏳ Building 📂ninja using CMakeLists.txt into 📂ninja/_My_Build...
⏳ Building 📂ninja using CMakeLists.txt into 📂ninja/_Build_Results...
...
✔️ Built 📂ninja in 47 sec
✔️ Built 📂ninja repository in 47 sec.
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
@ -66,11 +66,11 @@ param([string]$path = "$PWD")
function BuildInDir([string]$path) {
$dirName = (Get-Item "$path").Name
if (Test-Path "$path/CMakeLists.txt" -pathType leaf) {
"⏳ (1/4) Building 📂$dirName by using CMake into 📂$dirName/_My_Build..."
if (-not(Test-Path "$path/_My_Build/" -pathType container)) {
& mkdir "$path/_My_Build/"
"⏳ (1/4) Building 📂$dirName by using CMake into 📂$dirName/_Build_Results..."
if (-not(Test-Path "$path/_Build_Results/" -pathType container)) {
& mkdir "$path/_Build_Results/"
}
Set-Location "$path/_My_Build/"
Set-Location "$path/_Build_Results/"
"⏳ (2/4) Executing 'cmake' to generate the Makefile..."
& cmake ..
@ -184,7 +184,7 @@ try {
$repoDirName = (Get-Item "$path").Name
[int]$elapsed = $stopWatch.Elapsed.TotalSeconds
"✔️ Built repo 📂$repoDirName in $elapsed sec"
"✔️ Built 📂$repoDirName repository in $elapsed sec."
exit 0 # success
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
@ -192,4 +192,4 @@ try {
}
```
*(generated by convert-ps2md.ps1 using the comment-based help of build-repo.ps1 as of 01/25/2024 13:58:36)*
*(generated by convert-ps2md.ps1 using the comment-based help of build-repo.ps1 as of 03/27/2024 17:36:23)*