Die Zuständigkeit in Dateien zurückverfolgen, die generierten und handgeschriebenen Code mischen

Ziel

Die zuständige Quelle für einen strittigen Bereich in einer teilweise generierten Datei ermitteln, wenn der Generator unklar ist oder handgeschriebene Anpassungen sich dieselbe Datei teilen.

Voraussetzungen

Den betroffenen Bereich, den Repository-Verlauf, soweit verfügbar, und einen isolierten Arbeitsbereich bereithalten. Vor dem Vorschlagen einer Änderung feststellen, ob die Ausgabe vollständig generiert ist, geschützte handgeschriebene Bereiche enthält oder von mehreren Werkzeugen transformiert wird.

Schritte

1. Unterscheidbaren Text oder Symbole aus dem betroffenen Bereich bis in Vorlagen, Schemata, Build-Aufgaben und frühere Änderungen zurückverfolgen. Ist kein Generator benannt, mögliche Erzeuger und die jeweiligen Belege festhalten, die sie mit dieser konkreten Ausgabe verbinden.

2. Die Zuständigkeit für Bereiche explizit abbilden: generierte Blöcke, erhaltene Anpassungsblöcke und unbekannte Bereiche. Die tatsächlichen Erhaltungsregeln des Erzeugers nachlesen; ein Kommentar, der wie ein Grenzmarkierer aussieht, belegt für sich genommen nicht, dass er handgeschriebenen Code schützt.

3. In einer isolierten Kopie ohne beabsichtigte Quelländerungen neu generieren und das Ergebnis vergleichen. Beobachten, welche Bereiche überschrieben, erhalten oder umsortiert werden. Diese Untersuchung nicht durchführen, indem die einzige Kopie der handgeschriebenen Änderungen der nutzenden Person riskiert wird.

4. Die Korrektur in der nachgewiesenermassen zuständigen Schicht platzieren: Vorlage, Eingabedefinition, unterstützter Anpassungsbereich oder dokumentierter Postprozessor. Nachgelagerte Transformationen inspizieren, damit ein späteres Werkzeug die Änderung nicht rückgängig macht oder umdeutet.

5. Neu generieren und sowohl die beabsichtigte Korrektur als auch den Erhalt benachbarter handgeschriebener Inhalte prüfen. Eine Fixtur mit einem Anpassungsmarker und einem ähnlich geformten gewöhnlichen Kommentar einbeziehen, um zu weit gefasste Bereichszuordnungen zu erkennen.

Erwartetes Ergebnis

Die Änderung enthält eine Zuständigkeitskarte der Bereiche und einen reproduzierbaren Weg von der zuständigen Eingabe bis zur endgültigen Datei. Unbekannte Bereiche bleiben ausdrücklich ungeklärt, statt stillschweigend der nächstgelegenen Vorlage zugeordnet zu werden.

Grenzen und Prüfbasis

Diese ursprüngliche Untersuchungsmethode wurde hier nicht ausgeführt. Neugenerierung kann nicht verfügbar oder nichtdeterministisch sein, was die Zuständigkeitsbelege einschränkt. Unsicherheit bestehen lassen und die fehlenden Erzeugerinformationen einholen, bevor Bereiche geändert werden, die von Nutzenden gepflegte Logik enthalten könnten.