Joachim Merkel <[EMAIL PROTECTED]> wrote on 24.06.04:
> Michael Heydekamp ([EMAIL PROTECTED]) schrieb:
>> Mu� ich mir bei Gelegenheit mal ansehen. Ich bin nicht sicher, ob
>> die Version auf dem CVS inhaltlich ganz aktuell ist, evtl. mu� ich
>> noch ein paar Nachtr�ge vornehmen.
> Nur zu.
> Kannst mir ja Deine Snapshot.Txt mal senden.
Ich w�rde mir erst gerne selbst mal einen �berblick verschaffen. Welche
Version ist denn die letzte, bevor sie in das DOCFORM-Format gewandelt
wurde?
> Davon abgesehen ist es kaum m�hsam, die Snapsot.DQ auf dem CVS aktuell
> zu halten, der neue Text ist meist einfach anzuh�ngen, da die Liste
> der Entwickler nach oben gewandert ist.
Darin sehe ich auch kein Problem. Meines ist eher, den �berblick �ber
bereits abgeschlossene und noch in Arbeit befindliche (aber bereits
vorab dokumentierte) �nderungen zu behalten.
> [...]
>> Seit langem steht aber auch noch das Schlie�en der
>> Dokumentationsl�cke 1.1.2001 bis August 2001 an (das ist genau der
>> Zeitraum zwischen dem RC2 in VERSION.TXT und dem Beginn von
>> SNAPSHOT.TXT), der au�er in den CVS-Logs noch nirgends dokumentiert
>> ist.
> [...]
> Das war wohl vor Deiner Zeit bei OpenXP.
Das war vor zumindest meiner Zeit als Programmierer.
> BTW hat mich die thematische Zusammenfassung nicht wirklich �berzeugt,
> scheint auch eine Notl�sung gewesen zu sein. Ist zwar ganz nett zu
> lesen, aber vieles bleibt oder wirkt verwischt.
Es war ja so, da� ich im Juli/August 2001 als praktisch erste
Entwicklert�tigkeit einen ganzen Schwung Features von Jochen nach OpenXP
�bernommen hatte (wobei es mit einem simplen Eindiffen aufgrund des
stellenweise unterschiedlichen Codes nicht getan war), der zun�chst in
eine Testversion "v3.40my" gem�ndet ist und nach der Testphase in die
"echte" v3.40 committet wurde.
Jochen hatte damals schon f�r sich eine �hnliche Form der Dokumentation
praktiziert, wie wir sie aus SNAPSHOT.TXT kennen. Ich habe diesen
ganzen Schwung an �nderungen dann erstmal "en bloc" dokumentiert und
eben thematisch gegliedert (weil's ja zeitlich betrachtet auch ein Block
war).
Danach haben noch einige weitere �nderungen stattgefunden, die teilweise
noch mit dieser Feature-�bernahme im Zusammenhang standen, teilweise
auch nicht. Diese �nderungen wurden ohne genaue Angabe des Zeitpunkts
zun�chst ebenfalls diesen bei der o.a. Feature-�bernahme geschaffenen
Themenbereichen zugeordnet.
Erst ab Januar 2002 mit der Umbenennung nach "OpenXP/16" und sp�ter
"FreeXP" wurde dann in SNAPSHOT.TXT streng chronologisch
fortgeschrieben.
Geplant hatte ich eigentlich schon, die �nderungen vor Januar 2002 auf
das danach praktizierte Verfahren zur�ckzubauen, um zu einer
einheitlichen Form der Dokumentation zu kommen. Wobei der Feature-Block
von August 2001 dann eben einem Zeitpunkt (sinnvollerweise dem des
Commits, also 16.09.2001) zugeordnet werden sollte.
Hei�t also, da� der thematisch gegliederte Teil anhand von CVS-Logs und
-Diffs zeitlich wieder aufgedr�selt werden m��te. Ich f�rchte, da� ich
kaum drum herum kommen werde, das selbst zu machen, weil das f�r
jemanden, der nicht in die Details involviert war, zu schwierig und
un�bersichtlich ist. Ich h�tte aber auch nichts dagegen, wenn es jemand
versuchen w�rde, der die Zeit dazu hat.
[Dokumentation 1.1.2001 bis August 2001]
>> Das wird noch mal ein unangenehmes St�ck Arbeit werden[...]
> Wird sich wohl nicht vermeiden lassen. Davon abgesehen, ist der
> Hauptteil ja schon erledigt, immerhin l�uft das Programm ja schon eine
> Weile mit dem Source.
Was uns aber doch hinsichtlich der unvollst�ndigen Dokumentation nichts
hilft?
> Wenn man dann anschlie�end die Aufteilung des Source �ndert, um mal
> wieder mit Range-Checks zu kompilieren, geht die Arbeit von vorne los
> ;)
Eigentlich nicht. Wenn durch eine andere Aufteilung Codeteile von einer
Unit zur anderen (ggf. neuen) Unit wandern sollten, wird man nicht
hergehen und die Namen der Units von zur�ckliegenden �nderungen in
SNAPSHOT.TXT anpassen - viel zu aufwendig und ohnehin kaum m�glich.
Ein Bugfix oder Feature zieht sich mitunter �ber mehrere Routinen und so
kann es passieren, da� sich nach einer evtl. Neuaufteilung (die ich so
konkret auch gar nicht im Blick habe) ein Teil in der einen und der
andere Teil in einer anderen Unit befindet. Das kannst Du nicht mehr
sauber nachhalten, es sei denn mit unverh�ltnism��ig hohem Aufwand.
Eine evtl. Neuaufteilung wird man v�llig separat dokumentieren (m�ssen).
>> Falls Du oder jemand anderer Zeit und Lust dazu hat... Da die CVS-
>> Logs aus dieser Zeit leider nicht sehr aussagekr�ftig sind, wird man
>> stellenweise Diffs ziehen m�ssen, um �berhaupt sehen zu k�nnen, was
>> genau aus welchem Grund ge�ndert wurde.
> Naja immerhin noch Logs..habe ich zumindest keine Bedienprobleme mit.
> Aber wie ich gerade geschrieben hatte, mu� man den Entwicklungsgang
> sowieso genauer nachvollziehen, um zu einer angemessenen Darstellung
> zu kommen.
Richtig, siehe oben.
Michael
------------------------------------------------------------------------
FreeXP Entwickler-Mailingliste
[EMAIL PROTECTED]
http://www.freexp.de/cgi-bin/mailman/listinfo/dev-list
