Skip to content

Address property doc-nits.#9090

Closed
paulidale wants to merge 2 commits intoopenssl:masterfrom
paulidale:property-doc-fixes
Closed

Address property doc-nits.#9090
paulidale wants to merge 2 commits intoopenssl:masterfrom
paulidale:property-doc-fixes

Conversation

@paulidale
Copy link
Contributor

Addresses comments in #9042

  • documentation is added or updated

@paulidale paulidale requested a review from mspncp June 6, 2019 03:39
@paulidale paulidale added the branch: master Applies to master branch label Jun 6, 2019
"no".
the local clause overrides the context clause.

=head2 Override
Copy link
Contributor

Choose a reason for hiding this comment

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

The term "Override" does not fit anymore, use "Removal" or "Property Removal" instead?

Or maybe just remove the =head2 Override heading, making lines 136ff a second paragraph under =head2 Global and Local?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've taken the second option.


It is possible for a local property query to override a clause in the context
It is possible for a local property query to remove a clause in the context
property query by preceeding the property name with a '-'.
Copy link
Contributor

Choose a reason for hiding this comment

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

(An alternative would be to use the tilde instead of the minus sign for removal: ~prop instead of -prop)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

~ would be a good =false equivalent at some stage in the future. (alternatively !)

\ is one of the common symbols used for set removal/subtraction in mathematics. (- is the other one which is the symbol being replaced). Perhaps even / to save backslash for future use.

Thoughts anyone?

Copy link
Contributor

Choose a reason for hiding this comment

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

Well, I can live with the minus sign. The tilde was just a thought.

But you are right ?~prop looks much better than ?!prop, so let's better reserve the tilde for the unary negation operator. :-)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

?! has another meaning.

Copy link
Contributor

Choose a reason for hiding this comment

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

The more syntax you have now, "for convenience" the more you limit the future, having to work around things. Almost all uses will be "fips=yes" or "dont care about fips" Support that, only that, in this release.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It is fairly minimal at present. The only extra being the "optional" operator.

Copy link
Contributor

@mspncp mspncp left a comment

Choose a reason for hiding this comment

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

LGTM


It is possible for a local property query to override a clause in the context
It is possible for a local property query to remove a clause in the context
property query by preceeding the property name with a '-'.
Copy link
Contributor

Choose a reason for hiding this comment

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

Well, I can live with the minus sign. The tilde was just a thought.

But you are right ?~prop looks much better than ?!prop, so let's better reserve the tilde for the unary negation operator. :-)

@mspncp
Copy link
Contributor

mspncp commented Jun 6, 2019

If you squash the commit (which I assume you will), could you replace the term "doc-nits" in the commit message by something different? Because for me, a "doc-nit" is something that makes the doc-nits script fail.

Maybe something like:

Minor corrections to property manpage

levitte pushed a commit that referenced this pull request Jun 6, 2019
Reviewed-by: Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com>
(Merged from #9090)
@paulidale
Copy link
Contributor Author

Merged thanks.

Until 3.0 is actually released, the property definition and query syntaxes aren't fixed. There is still time to discuss -, ~, !, \ etc.

@kroeckx kroeckx closed this Jun 6, 2019
@paulidale
Copy link
Contributor Author

Apologies for forgetting to close this.

@paulidale paulidale deleted the property-doc-fixes branch June 6, 2019 21:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

branch: master Applies to master branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants