Descent3 icon indicating copy to clipboard operation
Descent3 copied to clipboard

Move old VCS text

Open Nakhr11n opened this issue 10 months ago • 3 comments

The old VCS text in most source files is in the way of the code. But it is useful to keep it around for context, just not in the source files themselves.

For example it could be put in an adjacent file: Descent3/LoadLevel.cpp (1200 lines of old VCS) -> Descent3/LoadLevel.cpp.old-vcs

Nakhr11n avatar Apr 20 '24 08:04 Nakhr11n

I don't think that extracting old changelogs from source files into another is good idea. In other hand, they dot not affects on building of project. I'd keep them in source for historical purpose.

winterheart avatar Apr 20 '24 09:04 winterheart

Most IDEs hide the first comment, expecting it to be some uninteresting copyright blurb - but here it is the historical VCS log.

Unfortunately, this just broke when @kevinbentley added an actual GPLv3 header :). This could be remedied by joining these two comments with a ---- separator and maybe adding a note that these are historical so nobody extends or modifies them.

th1000s avatar Apr 20 '24 16:04 th1000s

Most IDEs hide the first comment, expecting it to be some uninteresting copyright blurb - but here it is the historical VCS log.

Unfortunately, this just broke when @kevinbentley added an actual GPLv3 header :). This could be remedied by joining these two comments with a ---- separator and maybe adding a note that these are historical so nobody extends or modifies them.

I like this, although I'm not sure if license headers are required to be in their own comment section. If this is ok to do, perhaps a script could be made to walk through everything with ease.

JeodC avatar Apr 25 '24 00:04 JeodC