Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: clarify namespace in ABNF #48

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

jkowalleck
Copy link
Member

i found the docs confusing.

in the current ABNF it reads

property-name = 1*(namespace ":") name
; ...

the problem i saw: the namespace is used multiple time, so if i registered a namespace, how would i use it multiple times?

Here is a fix.

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
local:information_security_classification
local:team_responsible
```

### ABNF for Official CycloneDX Property Names

```
property-name = 1*(namespace ":") name
```ABNF
Copy link
Member Author

Choose a reason for hiding this comment

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


namespace = 1*namechar

name = 1*namechar
name = 1*namechar [":" name]
Copy link
Member Author

Choose a reason for hiding this comment

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

Alternative writing would be :

name =  1*namechar
name =/ name ":" name

@jkowalleck jkowalleck requested review from coderpatros and a team March 17, 2023 08:30
@coderpatros
Copy link
Member

i found the docs confusing.

in the current ABNF it reads

property-name = 1*(namespace ":") name
; ...

the problem i saw: the namespace is used multiple time, so if i registered a namespace, how would i use it multiple times?

Here is a fix.

Maybe it should be reworded instead? Instead of namespace maybe namespace-segment? The current syntax is to differentiate between namespaces, sub-namespaces, and the name of the property within the namespace. Thoughts?

@jkowalleck
Copy link
Member Author

jkowalleck commented Mar 27, 2023

re: #48 (comment)

then why not call these things exactly like that? how do you like te following?

property-name =  name
property-name =/ namespace ":" 1*(sub-namespace ":") name

namespace = 1*namechar
sub-namespaces = 1*namechar
name = 1*namechar

; ...

@jkowalleck jkowalleck added the documentation Improvements or additions to documentation label Jun 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants