Versioning of Documentation

General discussion for players of Oolite.

Moderators: winston, another_commander

Post Reply
User avatar
hiran
Theorethicist
Posts: 2446
Joined: Fri Mar 26, 2021 1:39 pm
Location: a parallel world I created for myself. Some call it a singularity...

Versioning of Documentation

Post by hiran »

As the project proceeds changes accumulate in the code, and partly they also get visible to users when handling the game.
Thus once in a while the documentation is updated.

In the past there was outdated PDF documentation shipped with the installers. This is fixed.
But you may still run into the question which of two documents is newer? Especially if you print it there is no but the hard way to spot differences.

Well - no longer. This is to let you know....
When Oolite is built on Github, the installers ship PDF documentation based on the latest .odt files in the repository, plus the Oolite version is stamped on the page footers. This way it takes only a brief glance at two documents to tell them apart or decide for the newer one.
Sunshine - Moonlight - Good Times - Oolite
user2357
Deadly
Deadly
Posts: 150
Joined: Tue Jan 21, 2020 3:37 pm

Re: Versioning of Documentation

Post by user2357 »

Excellent! Brilliant! Thanks, hiran. :D
User avatar
Cholmondely
Archivist
Archivist
Posts: 5947
Joined: Tue Jul 07, 2020 11:00 am
Location: The Delightful Domains of His Most Britannic Majesty (industrial? agricultural? mainly anything?)
Contact:

Re: Versioning of Documentation

Post by Cholmondely »

So if I could work out how to download an old version from GitHub, then I'd get inaccurate "futuristic" documentation with it?
Comments wanted:
Missing OXPs? What do you think is missing?
Lore: The economics of ship building How many built for Aronar?
Lore: The Space Traders Flight Training Manual: Cowell & MgRath Do you agree with Redspear?
User avatar
hiran
Theorethicist
Posts: 2446
Joined: Fri Mar 26, 2021 1:39 pm
Location: a parallel world I created for myself. Some call it a singularity...

Re: Versioning of Documentation

Post by hiran »

That's the beauty of version control:
If an old version would get built on Github it would get packaged with the matching old version of the documentation.

That's the consistency of version control:
If an old version would get built on Github it would get built using the old build procedure - which does not stamp version numbers on the page footers.

But under no circumstance expect old Oolite with new documentation.
Sunshine - Moonlight - Good Times - Oolite
Post Reply