Skip to content

Document GAMS nodlim as node_limit default and record the def source in the generated option table - #32

Merged
0x17 merged 1 commit into
mainfrom
doc-nodlim-source
Nov 18, 2026
Merged

0x17 merged 1 commit into
mainfrom
doc-nodlim-source

Conversation

@0x17

@0x17 0x17 commented Nov 18, 2026

Copy link
Copy Markdown
Member

Follow-up to #31, from the review of the GAMS documentation change that adds the cuOpt solver manual.

  • assets/optcuopt.def: the description of node_limit now ends with (default GAMS NodLim), like time_limit and iteration_limit. gmscuopt.c already passes GAMS nodlim (if > 0) as node limit, but the generated option table showed the default as infinity without linking to nodlim. This also changes the option help text that GAMS shows for node_limit.
  • optdef2md.py: new optional --source argument, recorded in the header of the generated table, e.g. --source "GAMS-dev/cuoptlink-builder v0.0.9b" gives <!-- This file is autogenerated by optdef2md.py from optcuopt.def of GAMS-dev/cuoptlink-builder v0.0.9b. -->. Without --source the output is unchanged. Values containing -- are rejected since they would end the HTML comment.
  • CONTRIBUTING.md: the generator command includes --source.

The cuopt-v26.12 branch needs the same node_limit line (or gets it when merged with main).

Testing

  • Generated table: compared to the current one, only the node_limit row changes (default now \ref GAMSAOnodlim "GAMS nodlim"); output without --source is byte-identical to before apart from that row
  • --source "a--b" exits with an error
  • GAMS' optcc reader still reads the changed optcuopt.def; all 130 options match the parsed data

@0x17
0x17 merged commit 505a6da into main Nov 18, 2026
6 checks passed
@0x17
0x17 deleted the doc-nodlim-source branch November 18, 2026 14:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant