You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
To keep clean releases, I thought it might be wise to document somewhere how to maintain everything. In particular, explain how to upgrade to a new CCX version with detailed steps, and what files need to be updated (eg. scripts depending on the version).
Also some minor cleanup along the way :)
Done:
Added a MAINTAINING.md file.
Added comments in ccx2.19.c to help locate adapter code more easily
Added an assertion in the command line arguments parsing to check for bounds.
Planned:
Cleanup of the Debian packaging & PaStiX script, to make it easier to update CCX version.
Documentation is always good 👍
But why here and not on the website? Is it to separate dev docs from user docs? I am not sure if the CalculiX docs is already large enough to force us to do that. We should at least link form the website to this file. Users should see this such that they help maintaining the CalculiX adapter in the long run.
I actually planned to ask what was the optimal location once I undrafted this PR, but you were faster :D
I have no hard feelings one way or another. I like having access to doc while offline (if I can access the repo but not the wesbite) but I see the perks of making it accessible to the website. As of now it's short enough to be contained on a single website entry so, why not.
I'll keep it here while i'm drafting it, but it'll be easier to transfer if needed once it's done, so let me know.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
To keep clean releases, I thought it might be wise to document somewhere how to maintain everything. In particular, explain how to upgrade to a new CCX version with detailed steps, and what files need to be updated (eg. scripts depending on the version).
Also some minor cleanup along the way :)
Done:
MAINTAINING.mdfile.ccx2.19.cto help locate adapter code more easilyPlanned: