1. Remarks
This documentation is a part of docu to the OFB concept: ../../fbg/html/Videos_OFB_VishiaDiagrams.html. It should be translate to English, later TODO
It shows the topic of Separation sources and artefacts, symbolic link to build results.
Especially: Commands mkSymbLink and readlink for Windows (and Linux, MinGW/MSYS2 compatible)
2. Approach
Für die kompatible Arbeit mit Shell-scripts in Windows (unter MinGW64/MSYS2) wurden Windows-Programme erstellt, die für symbolische Links sowie Anlegen und Cleanen von Verzeichnissen zuständig sind.
mkSymbLink readlink cleanDirTree mkDirTree
Veranlassung dafür war:
-
Diese Befehle sind zwar nativ in Windows ausführbar:
mklink /J,rmDir,rm …\*etc. -
Jedoch sind die adäquaten Linux-Befehle für symbolische Links für Shell-Scripting in MinGW so implementiert, dass sie nicht die für Windows geeigneten Junctions erzeugen. Die Konzepte für symbolische Links unter UNIX/Linux und in Windows sind nicht kompatibel abgestimmt. Ein
ln -sin einem Shell-Script abgearbeitet unter MinGW64/MSYS2 ist nicht brauchbar. -
Um in einem Shell-Script in der Windows-Umgebung symbolische Links als Junction zu erzeugen, müsste im Script eine Abfrage Linux/Windows einprogrammiert werden, und im Windows-Zweig müsste
cmd.exegerufen werden, um die Befehlemklink /Jetc. auszuführen. Denn diese Befehle sind nicht als.exevorhanden sondern interne Befehle descmd.exe. Das verkompliziert die Shell scripts in mehrerer Hinsicht:-
Abfrage Windows/Linux
-
Berücksichtigung spezieller Windows-Befehle, obwohl die Scripts von Nutzern eventuell nur in Linux verwendet werden, Pflegeaufwand dieser Teile.
-
Befehlsaufruf über eine komplex zu lesende Zeile, in der
cmd.exemit einigem Zusatzaufwand aufgerufen werden muss, beispielsweise ein davor gesetztesMSYS2_ARG_CONV_EXCL='*' ` vor `cmd.exe /C mklink /J …, damit in der MSYS2-Shellscriptverarbeitung nicht automatisch alle Slashes in Backslash verwandelt werden. -
Dokumentation dieser Detais, denn ein durchschnittlicher Anwender, der die Scripts liest, Shellscripts prinzipiell kennt, aber nicht in allen Details firm ist, weiß sonst gar nicht wozu das gut ist.
-
-
Dazu kommt das Problem, dass oft Fehlermeldungen von Windows-Befehlen nicht genügend genau sind, beim Scripting schlecht angezeigt werden (das typische: "Befehl oder Dateiname kann nicht gefunden werden" ohne Angabem welcher Befehl).
Alles in allem, diese Welten sind imkompatibel und nicht gut brauchbar.
Die Windows-API, intern in C/++ nutzbar, bietet alle Notwendigkeiten. Die neu geschaffenen Commands nutzen diese, und sind mehr anwenderfreundlich als die im Stand der Technik gebotenen.
Für Linux wurde ein jeweils kompatibler Befehl vorerst als Shellscript verwendet. Damit ist der Aufruf im Shellscript, beispielsweise
"$WD/tools/mkSymbLink" src/+StatePosCtrl/cpp/genSrc/FBcl "$WD/build/+StatePosCtrl/cpp/genSrc/FBcl" -F
um gezielt einen symbolischen Link in einem lokalen Source-Verzeichnis auf generierte Sources in einem build zu setzen,
für beide Systeme identisch. $WD zielt hier auf das Arbeitsverzeichnis.
In dessen $WD/tools ist für die Windows-Ablage das mkSymbLink.exe enthalten, und in der Linux-Ablage ein adäquates Shell-Script.
Somit braucht es nur eine Zeile für beide Systeme.
mkSymbLink sollte entweder als mkSymbLink.exe oder als Linux-Version eigentlich in einem Verzeichnis im PATH erreichbar stehen.
Das wird in dem angegebenen Beispiel nur 'noch nicht' vorausgesetzt.
Würden diese Befehle für Windows nicht fest als .exe programmiert, sondern jeweils als fertige aufrufbare Scripts zur Verfügung gestellt werden,
dann hätte man wieder zwei Probleme:
-
a) Unterscheidung Linux/Windows in Shellscripts notwendig
-
b) Komplexe Zeile mit
cmd.exe /C …im Shellscript, unverständlich für Nur-Linux Nutzer. -
c) Wahrscheinlichkeit, dass in diesen Scripten vom Anwender etwas 'angepasst' wird, möglicherweise als 'Verschlimmbesserung', d.h. nicht ausreichend für alle Fälle getestet, und dennoch als zentrales Script bereitstehend
-
d) Oder alternativ an mehreren Stellen fast die gleichen und doch im Detail auseinander weichenden Scripts.
Die Bereitstellung als Executable in Windows ist die mehr beständig und belastbare Version. In Linux sollten die gleichen Befehle ebenfalls fest programmiert bereitstehen (TODO, 2026-11). Die Bereitstellung als Script ist also nur ein Kompromiss, damit es verwendbar ist.
3. Verfügbarkeit der Befehle mkSymbLink, readlink, cleanDirTree, mkDirTree
Die Executables dieser Befehle sind im Archiv https://www.vishia.org/Linux/deploy abgelegt und über folgende BOM-Zeilen downloadbar:
GET-URL-W readlink.exe; https://www.vishia.org/Linux/deploy/readlink-2026-10-27.exe; cf4b19946f900285a043b29c35d4e48ee56cf75ca0b202cfe8499fd20f1a1e3b; GET-URL-W mkSymbLink.exe; https://www.vishia.org/Linux/deploy/mkSymbLink-2026-10-27.exe; 588aadc021eb0cf215544278d2fa7763f0b145dac6d3bb3e298b5bdd5a514b70; GET-URL-Z Linux-Windows-Tools-src-2026-10-27.zip; https://www.vishia.org/Linux/deploy/Linux-Windows-Tools-src-2026-10-27.zip; b1a6683be016651ad365f042a686fe78492046d396b999e10144ed27af9dc1;
Zum Konzept dieses "software Bill Of Material" (BOM) Approaches siehe https://www.vishia.org/SwEng/html/download-from-URL.html. Die Sources sind in dieser BOM als Zip mit enthalten.
Ein git-Repository der Sources findet sich unter https://gitlab.com/jzhartmut/Windows-Tools
Man kann also entweder 'nur' die Executables downloaden, oder sich mit den zugehörigen Sourcen beschäftigen und selbst kompilieren. Die Compilierung sollte dem "Reproducible Build"-Approach genügen, also die Selbst-Compilierung mit den gleichen Tools (MinGW) sollte binäridentische Sources erzeugen. Das ist bisher leider noch nicht verifiziert (TODO)
4. Beschreibung der Befehle
4.1. mkSymbLink link-path target-path [-F] [-L] [-T]
mkSymbLink.exe: Erstellt in Windows einen symbolische Link als Junction.
Im NTFS-Dateisystem in Windows ist das sehr gut nutzbar, auch über Netzwerkgrenzen, auch über Samba von Linux aus sichtbar.
Dieser Befehl ist eigentlich unter Windows eben gerade nicht notwendig, weil er mit mklink /J dst
src auch in Batch-Scripten ausgeführt werden kann.
Aber dieses mklink /J macht Ärger in einem shell-Script unter MinGW.
mklink ist ein internes Command der cmd.exe, muss also in einem Shellscript über cmd.exe aufgerufen werden.
Das verkompliziert die Scripts, macht eine Unterscheidung zwischen Linux und Windows in diesen Script-Teilen notwendig.
Die mkSymbLink.exe auch in Linux bereitgestellt einfach als kleines Shell-Script
mkSymbLink in den PATH aufgenommen ruft intern ln -s auf.
Das ist im Linux-Filesystem die adäquate Lösung eines normalen symbolischen Links und macht die Shell-Scripts kompatibel.
Dieser Befehl erzeugt derzeit (2026-11) in Windows eine JUNCTION und in Linux einen Symbolic link im letzten Element des link-path gespeichert
auf den target-path. Der Link wird als absoluter Link gespeichert, ist also nicht für verschiebliche Inhalte (mit relativen Links) geeignet.
Die absoluten Links sollten immer dann verwendet werden, wenn Links in einem Arbeitsverzeichnis 'on demand', wenn notwendig, angelegt werden.
Als Besonderheit gegenüber dem Windows-Befehl mklink /J …:
-
Ist das Link-Verzeichnis nicht vorhanden, dann wird es wie bei
mklink /Jangelegt. Der Parent-Path, das Verzeichnis, in dem der Link eingerichtet wird, muss vorhanden sein. Das hilft, bei Schreibfehlern nicht einen ungewollten Path anzulegen. -
Ist das Link-Verzeichnis bereits fertig auf den richtigen target-path eingerichtet, dann wird nach diesem Test nichts weiter unternommen. Alles ist gegeben wie gewünscht.
-
Ist das Link-Verzeichnis als solches vorhanden, zeigt aber auf einen anderen target-path, dann wird der Link gelöscht und neu eingerichtet. Dazu ist die Option
-Loder auch-Fnotwendig. Dieser Fall dürfte häufig auftreten, beispielsweise wenn bei einer neuen "build"-Aktion die Ergebnisse woanders, daneben, gespeichert werden sollen. -
Ist das Link-Verzeichnis als direktes verzeichnis vorhanden, dann wird das gesamte Verzeichnis gelöscht, wenn die Option
-F("force") gesetzt ist. Das ist bespielsweise für Anwendungen sinnvoll, bei denen zuvor kein Link vorhanden war und folglich erzeugte Files gespeichert wurden, nunmehr aber ein Link verwendet werden soll. Beispielsweise auch auf eine RAM-Disk. Zu beachten ist, dass die vorher dort stehende Inhalte persistent gelöscht werden. Die Option-Fsollte also nur angegeben werden, wenn es sich beim Zielverzeichnis um Files handelt, die als Generate oder "artefacts" gespeichert sind und eben neu generiert werden sollen. Dem Anwender ist es überlassen, vorher nachzuschauen und ggf. eine Sicherungskopie zu erstellen. In der Regel ist das aber ein Fall der täglichen Arbeit, bei der Generate, das sind auch Object-Files oder temporäre Logs, im Erstellungsprozess ständig neu erzeugt werden. Die Erstellung von Sicherungskopien für die Generate ist dann immer ein extra Thema außerhalb der Datenspeicherung auf demlink-pathgeregelt. -
Ist das Link-Verzeichnis mit einem einzelnen File besetzt, dann wird dieser ebenfalls mit der Option
-Fgelöscht. -
Ist das Ziel-Verzeichnis, der
target-pathnicht vorhanden, dann wird es angelegt, wenn die Option-Tgegeben ist. Damit wird verhindert, dass der Link in’s Leere geht. Der Link ist zu gebrauchen. Diese Eigenschaft wurde von mir in zweierlei Hinsicht positiv verwendet:-
target-pathist eine Destination für Generate, die erst noch generiert werden. Der Destination-Path alstarget-pathdes Links steht dann sofort bereit. -
target-pathist eine Quelle um Files zu lesen, die von jemand anderes generiert wurden oder ggf. noch nicht generiert wurden. Dann ist der Link auf jeden Fall gebrauchsfähig, enthält noch keine Daten, die aber bei der Generierung dann erzeugt werden und mit 'Refresh' dann auch angezeigt werden.
-
-
In beiden Fällen ist diese Eigenschaft also sehr hilfreich. Mit dem einfachen orginalen
mklink /Joder auchln -sist sie nicht gegeben. Der Link wird dabei zwar angelegt, ist aber (zunächst) eindangling link. -
Ist der
target-pathnicht vorhanden und-Tist nicht gegeben, dann beendetmkSymbLinkmit einer Fehlermeldung. Das ist dann zu gebrauchen, wenn nicht ein leeres Verzeichnis jedenfalls angelegt werden soll, sondern der Link soll auf ein definitiv vorhandenes Verzeichnis gehen. Imln -sodermklink /Jwird der Link dennoch angelegt, ist aber ungültig. Es wird kein Fehler ausgegeben. Das ist für die Anwendung eher ungüstig. Die Auswahl der Option-Tfehlt bei den originalen Betriebssystem-Commands. -
Ist der
target-pathvon einem einfachen File präsentiert, dann wird kein symbolischer Link auf den File angelegt sondern das File wird dann gelöscht und statt dessen ein leeres Directory angelegt, wenn neben der Option-Tauch-Fgegeben ist ("force"). Hier hat das "force" also auch die adäquate Wirkung auf dentarget-pathwie auf denlink-path, er wird erzwungen. -
Inhalte, die auf dem
target-pathals Directory vorhanden sind, werden nicht gelöscht. Um diese bei Bedarf zu löschen, musscleanDirTree link-pathgerufen werden, nachdem der Link erfolgreich angelegt wurde, oder auchcleanDirTree target-pathauch vor dem Legen des Links.
Folglich führt der einfache Befehl mkSymbLink link-path target-path -FT dazu, dass der Link auch unter den beschriebenen vorher gegebenen Umständen
sicher angelegt wird und sofort gebrauchsfähig ist.
Fehler, die dazu führen, dass der Link nicht angelegt wird, sind folglich grundsätzlicher Natur:
-
Verzeichnis, auf den der Link angelegt wird, ist nicht vorhanden. Dieses Verzeichnis wird vorausgesetzt.
-
Der
target-pathist nicht anlegbar, weil beispielsweise ein falsches Laufwerk angegeben wurde. Beispielsweise ist beim mir eine RAM-Disk nach Neu-Booten des Rechners immer vorhanden und in Windows aufT:gemounted. Ist diese nicht vorhanden, dann ist etwas Grundsätzliches beim Booten schief gegangen, das erst noch geklärt werden muss. -
Ein vorhandenes Verzeichnis anstelle des
link-pathist nicht löschbar. Das ist ein durchaus typischer Fall, wenn in diesem Verzeichnis (versehentlich) ein Editor offen ist, der den File lockt (den man vorher mal angeschaut hatte), oder einfach nur ein inneres Verzeichnis irgendwo aktiv angewählt wurde. Entweder dies ist ein Hinweis darauf: "Bitte überlegen ob etwas gespeichert werden soll", oder es ist schlichtweg nur stehen geblieben. Das Löschen des verzeichnisses ist aus Windows-internen Gründen dann nicht möglich undmkSymbLinkkehrt mit einemERRORLEVELzurück. Im Unterschied zu dem, was man gewohnt ist "was ist denn nun schon wieder los", wird der Pfad der Datei / des Verzeichnisses, die nicht löschbar ist, in der Fehlermeldung /Fehlerausgabe des cmd angezeigt. Man wird sich dann schneller erinnern "ach ja, da habe ich ja reingeschaut" und die ursache schnell beseitigen können. Dies ist auch eines der Hauptgünde, warum der hier compilierte Befehl besser ist als ein adäquates Batch-Script für diese Arbeit. Einrm -r linkdir\*meldet sich nicht mir dem entsprechenden Fehlerhinweis.
Bei einem Fehler endet mkLinkDir mit einem ERRORLEVEL, der dem Fehlercode aus <winerror.h> entspricht, auch nachlesbar in:
Allerdings, da eine Klartextfehlermeldung angegeben ist, sollte der genaue Fehlercode nur dann von Intereesse sein, wenn er einem seltenem Fall entspricht und daher in der Klartextausgabe fehlt. Grundsätzlich ist bei einem ERRORLEVEL die gesamte Bearbeitung zumeist abzubrechen und die grundlegende Ursache zu suchen. Eine gezielte ERRORLEVEL Reaktion in einem Script ist nicht angedacht.
4.1.1. Absolute and relative symbolic links
Hint: Generated by ChatGPT:
A symbolic link stores a path to its target. This path can be absolute or relative.
-
An absolute link contains a complete path, starting at the filesystem root (or drive root on Windows). It continues to refer to that location even if the directory tree containing the link is moved.
-
A relative link contains a path relative to the directory containing the link itself, not relative to the current working directory at the time of creation or use.
Relative links are especially useful for directory trees that are intended to remain portable and may be moved as a whole.
Example on Linux:
ln -s ../../target path/to/link
The link path/to/link stores the text ../../target.
When the link is followed, this path is resolved relative to
path/to/, resulting in the target directory target.
The current working directory is relevant for locating the link to be created, but not for interpreting its stored target path.
Windows also supports relative directory symbolic links, created
with mklink /D. However, directory junctions (mklink /J) are
a different Windows link type and should not be assumed to have
the same relative-path behavior.
4.1.2. Verwendung Junction oder Directory Symbolic Links in Windows
Derzeit ist bei den Anwendungen auf Junctions orientiert worden. Diese werden mit Windows-Originalbefehlen mit
mklink /J link target
erzeugt.
Die "directory symbolic links" sind nur als Adminstrator erzeugbar mit
mklink /D link target
und unterstützen ausdrücklich auch relative Links.
Ob die Verwendung der Windows-API die Adminstrator-Rechte erfordert, muss noch getestet werden. Die Adminstrator-Rechte wurden in Windows vermutlich deshalb eingeführt, weil dem Normal-Anwender die Verwendung solcher Links nicht zugemutet wurde. Jedoch, für jedes Script gleich Adminstrator-Rechte zu benötigen, ist wohl etwas übertrieben. Daher habe ich mich bisher nur auf die auch leistungsfähigen Junctions konzentriert.
4.1.3. Zweck von symbolischen Links, mit einer historischen Betrachtung
Zu diesem Thema eine kurze Historie:
In UNIX waren Symbolic Links bereits in den 1980-ern Gang und Gäbe. Es war schlichtweg Usus, dass man den Zugriff auf Files aus verschiedenen lokalen Verzeichnisbäumen braucht. Das war nicht im Fokus des neu aufkommenden DOS, das zwar von UNIX den Verzeichnisbaum abgeschaut hatte (bei CP/M gab es das auch noch nicht), aber viel mehr nicht. Der Slash wurde zum Backslash, weil der Slash bei CP/M üblicherweise das erste Zeichen für Optionen war. Spätestens seit Windows-NT in den 1995-ern hätte man erwarten können, dass es etwas Vergleichbares wie Symbolic Links unter UNIX gäbe. Es gab aber nur die {lbdquo}Verknüpfungen“, die im Explorer angeboten waren, nicht im Betriebssystem selbst verankert. Unter Vista gab es dann erstmals die {lbdquo}JUNCTION“, die die Explorer-Verknüpfung auf die Ebene des Betriebssystems abhob, also auch für andere Programme in der API (Application Interface) des Betriebssystems zugriffsfähig waren. Jedoch gibt es den Eindruck, es wurde unterstellt, der normale Windows-Anwender damit nicht zurecht kommt. Daher war nicht sehr viel davon zu Lesen und zu Hören. Ich selbst habe die Symbolic Links erst ca. 2020 unter Windows 10 entdeckt und sofort schätzen gelernt.
Mit dieser Historie und im Zusammenhang mit der Umstellung der DOS-lastigen cmd.exe und Batch-Verarbeitung gab es den Umstieg nach der {lbdquo}Powershell“, die natürlich sehr viel mehr konnte als die alte Batch, und auch mehr als Linux, nicht dass das etwa zusammenwachsen könnte (was zusammen gehört). Damit wurden wichtige Dinge im Zusammenhang mit den Symbolic Links im Fokus der cmd.exe nie als Standard realisiert. Die Hälfte der Experten sind sowieso komplett auf eine Linux-Umgebung unter Windows ausgewandert, die andere Hälfte ist von der Powershell überzeugt.
Diese fehlenden Befehle, es sind zwei, wurden von mir in diesem Projekt hinzu gesetzt und sind allgemein verwendbar. Denn: Der Kern des Betriebssystems von Windows unterstützt dies alles, nur die Zugänge für die Batch-Verarbeitung fehlen. Es handelt sich bei den Realisierungen um einfache C-Programme, die intern die Windows-API aufrufen:
-
readlink.exe: Dies entspricht in etwa demreadlinkin Linux, gibt den PATH als {lbdquo}canonical“ mit aufgelösten Links aus. Das dient dem Test ob ein Link dorthin zeigt wie erwartet. Im Windows fehlt das für die Batch-Verarbeitung. Man kann es ja mit Augen sehen, wenn mandiraufruft, und das genüge ja dem OttoNormalUser.
Leider arbeitet ln -s in einem Shellscript auf einer Windows-NTFS-Partition (über MinGW/MSYS2)
nicht mit einer Junction, sondern kopiert teils die Files, abhängig von weiteren Einstellungen, ist also
nicht nutzbringend unter Windows/MSYS2 verwendbar.
Diese beiden Executable werden im OFB_Presentation-Download mit einem Batch-Script
einschließlich der Sources von der vishia-Webseite mit Prüfcode downgeloaded, und sollten für die
Verwendung in ein Verzeichnis kopiert werden, dass im PATH liegt (C:\Programs\Batch).
Über den Prüfcode sind sie Virengesichert und können auch selbst neu compiliert werden, sowohl mit
Visual Studio (cl.exe) als auch mit dem GNU gcc beispielsweise im hier vorgestelltem MinGW.
4.2. cleanDirTree dir-path
Der Befehl cleanDirTree dir-path sorgt dafür, dass ein leeres Verzeichnis mit dem angegebenem Namen vorliegt.
-
Das Verzeichnis wird angelegt wenn nicht vorhanden und steht daher leer zur Verfügung,
-
oder dessen Inhalt wird gelöscht wenn es vorhanden ist.
-
Zeigt der dir-path auf ein File, dann wird das File gelöscht und statt dessen ein Verzeichnis angelegt.
-
Zeigt der dir-path auf einen symbolischen Link (eine Junction in Windows), dann wird der Inhalt des symbolischen Links gelöscht. Der symbolische Link wird, genau wie ein vorhandes Verzeichnis, beibehalten. Nur der Inhalt wird gelöscht.
Dieser Befehl ist dafür da, temporäre Inhalte zu löschen. Das Löschen erfolgt endgültig. Der Befehl sollte also nicht versehentlich mit einem dir-path auf wichtige Daten gestartet werden. Nebenbemerkung: Dafür sollte es eine Datensicherung geben.
Typische Anwendungsfälle ist das Löschen von Build-Verzeichnissen, um einen leeren Anfangszustand zu haben (ein build-all-Approach). Das ist oft auch extrem wichtig, wenn am Build-System selbst gearbeitet wird und gegebenenfalls falsche Inhalte irritieren.
Typisch für das Build-Verzeichnis ist die Verwendung einer RAM-Disk.
Dieser Befehl ist eine Kombination aus einem möglichen Batch-Script
if not exist "%~1" ( mkdir "%~1" ) else ( del /F/S/Q "%~1\*" )
Das Verzeichnis wird also entweder angelegt, wenn nicht vorhanden, oder dessen Inhalt wird gelöscht, nicht aber das Verzeichnis selbst. Es stellt einen vorhandenen "clean"-Zustand für das Verzeichnis her.
Die einfache Befehlsfolge im Batch-script kann unter MinGW64/MSYS2 so nicht ausgeführt werden, da es sich bei den Windows-Befehlen nicht um vorhandene Executable handelt, sondern um intere cmd.exe-Befehle.
Allerdings ist im MinGW64/MSYS2 (anders als bei ln -s) das adäquate Shell-script aufrufbar:
if ! test -d "$1"; then mkdir -p "$1" else rm -r "$1"/* fi
Gegenüber dem Aufruf von
cleanDirTree "$1"
sind die Scriptbefehle etwas schwerer les- und nach vollziehbar.
Zudem meldet die Windows-Version mit del zwar, welche Files sie gelöscht hat.
Sie meldet aber nicht, bei welchem File oder Directory es Probleme gab. Man bekommt keine klare Fehlermeldung.
Die Linux-Version meldet (beispiel):
$ ./testClearDirTreeBatch.sh T:/tmp/ramdisk/ljnux-WindowsToolds-build rm: das Entfernen von 'T:/tmp/ramdisk/ljnux-WindowsToolds-build/MSCobj' ist nicht möglich: Device or resource busy
In diesem Beispiel wurde das Verzeichnis MSCobj fest gehalten, indem ein Konsolenfenster dort geöffnet wurde. Immerhin ein Hinweis.
Dagegen meldet cleanDirTree:
$ cleanDirTree T:/tmp/ramdisk/ljnux-WindowsToolds-build ERROR on clean directory tree, File/Dir is shared by another process: T:/tmp/ramdisk/ljnux-WindowsToolds-build\MSCobj
Hier erfolgt die klare Ansage, dass ein anderer Prozess das Verzeichnis benutzt. Besser verständlich als 'busy' = "beschäftigt" - mit was?
Nebst dem einfachem Aufruf unter Windows und Linux ist der weitere Vorteil die klarere Fehlermeldung, wenn es nicht geht.
4.3. readlink link-path [-/] [-a|-A]
readlink ist in einer MinGW/MSYS umgebung nicht notwendig und wird auch nicht aufgefunden, da dort der gleichnamige UNIX/Linux Befehl verwendet wird.
Im reinen Windows fehlt er allerdings. Hier ersetzt readlink diesen gleichnamige Linux/Unix Befehl.
readlink ist also eigentlich nur als "Abfallprodukt" hier nach außen geführt.
Innerhalb des mkSymbLink wird der Algorithmus und Win-API-Aufruf benutzt, um festzustellen ob ein Link bereits richtig steht.
Für Windows-Nutzer ohne MinGW/MSYS wäre es ggf. auch interessant, den Befehl realpath zu haben.
Der Unterschied: realpath gibt den absoluten tatsächlichen Pfad, links sind aufgelöst, zurück.
readlink gibt nur zurück, was in einem Link steht, also den relativen Pfad, wenn dieser so gespeichert ist.
readlink ist aktuell hier nicht weiter beschrieben und wird derzeit auch nicht empfohlen in Scripts zu verwenden,
da nicht notwendig unter MinGW/MSYS und ggf. noch zu überarbeiten.
Hinweis für Test in Windows:
>fsutil reparsepoint query <link-path>
Damit werden einige innere technische Informationen zu einem Link angezeigt.
5. Anwendungsbeispiele
5.1. A
5.1.1. 7.3.3 mklink_build.bat Allgemeines Script für build-Link Windows
Das folgende Script baut auf die im Vorkapitel gezeigten zwei Zusatz-Commands für Windows auf. Es richtet Symbolic links speziell für das build-Directory in einer reinen Windows-Umgebung ein. Dieses Script ist folglich auch dann geeignet, wenn jemand nur unter Windows arbeiten möchte, den gcc-Compiler unter MinGW nicht einrichtet, beispielsweise mit Visual Studio für Windows und mit Embedded Control IDEs arbeitet.
include:scripts/WindowsEnv/mklink_build.bat::$::92::[]
Das Script wird aus verschiedenen Verzeichnissen heraus gerufen und steht zentral in src/ scripts/WindowsEnv/.
Damit brauchen Änderungen für einen angepassten Speicherort für Build, für die mögliche RAM-Disk, und
für den Verzeichnisnamen im temporären Speicherort nur einmalig vorgenommen werden.
Das betrifft insbesondere auch die Anpassung an die eigenen OFB-Projekte; der Verzeichnisname
OFB_Presentation sollte selbstverständlich an das eigene Projekt angepasst werden.
Das gilt dann für alle Komponenten in diesem gemeinsamen Verzeichnisbaum.
Hat man beispielsweise einen ähnlichen Verzeichnisbaum, evtl.
für die {lbdquo}alte Version“, dann werden diese auch im Temporärbereich des build korrekt unterschieden.
Die anzupassenden Zeilen stehen immer am Anfang des Scripts mit dem Hinweis ADAPT.
Als Start-Script auf der Root-Ebene des Verzeichnisbaums wird es wie folgt aufgeufen:
../+mklink_build.bat
Das Script muss aus diesem Verzeichnis heraus gestartet werden, damit das Current Directory dass der Root ist. Mehr ist nicht nötig.
Wir das Script aus einem VSCodium Arbeitsbereich gestartet, dann kann das wie folgt aussehen:
IDE/+StatePosCtrl/VSCodium_Windows/+clean_build.bat
Der Aufruf mit "%~dp0" übergibt das Aufruf-Verzeichnis als das jenige, in dem das verlinkte build eingerichtet wird.
Das zeigt mit dem Link auf genau die selben (und nicht nur die gleichen) Artefakt-Files.
Zusätzlich werden in diesem File mit der Bezeichnung clean{…} vorhandene Files der
Zmake-Generierung gelöscht, es wird ein Clean-Anfangszustand eingestellt.
Temporäre Verzeichnisse, ebenfalls möglichst in der RAM-Disk, werden ebenfalls damit beispielsweise beim
MS-Visual Studio Compiler eingestellt.
Für diesen Zweck gibt es das dritte Argument, den Namen des verlinkten Verzeichnisses.
Ohne Angabe ist dieser per default build, mit Angabe eben beispielsweise debug oder release für die
5.1.2. 7.3.4 mklink_build.sh Allgemeines Script build-Link für Linux / MinGW
Die Links für build usw.
müssen vor dem build-Vorgang gesetzt sein, sonst wird doch wieder ein build-Verzeichnis auf der SSD angelegt.
Dazu ist für jedes Betriebssystemumgebung ein allgemeingültiges Script unter
OFB_Presentation/scripts/SYSTEM_Env abgelegt, dass folgend für Linux gezeigt wird:
include:scripts/LinuxEnv/mklink_build.sh::$::92::[]
Dieses Script sollte eigentlich selbstdokumentierend sein, wenn die Shellscript-Statements alle bekannt sind.
Wichtig ist, zu Anfang können die Umgebungsvariable TMP_RAM und DIRNAME_BUILD geändert werden.
Bei TMP_RAM im Linux ist vorausgesetzt, dass die RAM-Disk genau dort liegt, sie kann so eingerichtet
sein oder werden, könnte aber auch woanders liegen.
Ist der Path ungültig, dann wird unter /tmp/ direkt angelegt:
DIRNAME_BUILD ist der Verzeichnisname, wo das allgemeine build im Temporärbereich abgelegt wird.
Der Verzeichnisname muss eindeutig sein, wenn man ggf.
mit verschiedenen Arbeitsverzeichnissen gleichzeitig arbeitet, und sollte andererseits einheitlich für
alle build-Links sein, die teils parallel zu src in OFB_Presentation/build angelegt werden, aber auch in den einzelnen WorkingDir von ggf.
verschiedenen VSCodium Projekten.
Auch die VisualStudio-Temporärfiles (in Windows) sollten darauf bezogen sein.
Für Windows gibt es in scripts/WindowsEnv/mklink_build_tmpRAM.bat und
scripts/MinGW64_Env/mklink_build_tmpRAM.sh das adäquate Script als batch bzw.
Shell-script für MinGW mit den selben Einstellungsmöglichkeiten.
5.2. 7.3 Anmerkung und Scripts für build, Artefakte, Speicherort
5.2.1. 7.3.1 Trennung von Sources und erzeugten Files
Der Begriff "Artefakt" = "künstlich erzeugt" wird häufig für generierte Files verwendet, also für Object-Files, aber auch Datenbanken für Code-Navigation, Autocompletion (IntelliJ-Funktionen, (https://en.wikipedia.org/\|wiki/IntelliJ_IDEA).
Die generierten Sources aus OFB sind genau genommen ebenfalls Artefakte.
In den vergangen Jahrzehnten wurden solche Artefakte über eine Session gern beibehalten, da die Build-Zeiten für das Neu-Erstellen recht lang waren und sich eigentlich nichts geändert hat. Ab und an war dann doch der Ruf nach einem {lbdquo}Build all“ lauter geworden.
Das ist heute so nicht mehr zutreffend. Build-Zeiten sind in der Regel schneller geworden. Für die aktuelle Arbeit ist ein {lbdquo}Build all“ dennoch lästig, und eigentlich nicht notwendig, wenn zu Anfang mit einem Clean-Zustand begonnen wird.
Der Clean-Zustand ermöglicht die Nutzung einer RAM-Disk für Artefakte, ohne Datenspeicherung auf der SSD oder HD.
Das hat zusätzlich den Vorteil, dass das Schreiben von Files (und teils auch Lesen, obwohl das Caching
von Files im RAM hier schon automatisch viel verbessert) schneller geht, und dass zusätzlich die SSD geschont wird.
Die Möglichkeit der Einrichtung einer RAM-Disk unter Linux als auch unter Windows ist allgemein bekannt oder nachlesbar.
Meine eigenen Erfahrungen seit einigen Jahren haben gezeigt, dass es problemlos möglich ist, im
Windows-10 das gesamte %TMP%-Verzeichnis grundsätzlich auf die RAM-Disk umzulegen, beim Neustart
mit einem leeren %TMP% zu beginnen.
Der andere Aspekte mit den Artefakten ist, dass man immer die eigentlichen Sources von den Artefakten, die nur eine temporäre Rolle spielen, separieren sollte. Das Endprodukt, eine Executable, enthält auch ohne die ObjectFiles alle Informationen zum Debuggen, wenn sie im Debugmodus übersetzt wurde. Siehe auch 7.6.5 Extension zum Debuggen: kylinIdeteam.cppdebug Seite PDF@14. Das Argument, man bräuche die Objects für ein Nachstellen von Fehlern, ist falsch.
Daher wird bei der gesamten Generierung für den Test mit einem abgetrennten build-Verzeichnis gearbeitet.
Das build ist mit symbolischen Links auf den Temporärbereich umgeleitet und damit sauber von den
Sources im Arbeitsbereich getrennt.
Der Temporärbereich kann und sollte auf einer RAM-Disk liegen.
Das betrifft auch wenn möglich Zwichenspeicher für cache-Bereiche für IntelliJ, bei VSCodium möglich,
bei VisualStudio für den db-File leider nicht möglich.