Skip to content

docs: fix line length bug in gen.pl#6438

Closed
cvengler wants to merge 1 commit into
curl:masterfrom
cvengler:2021-01-fix-gen-pl-warning
Closed

docs: fix line length bug in gen.pl#6438
cvengler wants to merge 1 commit into
curl:masterfrom
cvengler:2021-01-fix-gen-pl-warning

Conversation

@cvengler

Copy link
Copy Markdown
Contributor

The script warns if the length of $opt and $desc is > 78. However, these
two variables are on totally separate lines so the check makes no sense.
Also the $bitmask field is totally forgotten. Currently this leads to
two warnings within --resolve and --aws-sigv4.

@cvengler cvengler force-pushed the 2021-01-fix-gen-pl-warning branch from 2c0e59d to b398571 Compare January 11, 2021 19:30
@cvengler

Copy link
Copy Markdown
Contributor Author

While thinking about it, maybe it's even better to remove the check and leave this up to checksrc 🤔

Comment thread docs/cmdline-opts/gen.pl Outdated

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should spell out exactly what is too long in the error message. Maybe easiest by doing three different checks?

However, I don't think the bitmask length is the same as the others as that's a generated set of defines that this script could instead line-wrap if it turns out too long.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I updated it as you wanted it to some degree and removed the bitmask length check.

The script warns if the length of $opt and $desc is > 78. However, these
two variables are on totally separate lines so the check makes no sense.
Also the $bitmask field is totally forgotten. Currently this leads to
two warnings within `--resolve` and `--aws-sigv4`.

Closes curl#6438
@cvengler cvengler force-pushed the 2021-01-fix-gen-pl-warning branch from b398571 to ccfdf5c Compare January 12, 2021 06:41
@bagder

bagder commented Jan 12, 2021

Copy link
Copy Markdown
Member

Thanks!

@bagder bagder closed this in 324cf1d Jan 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants