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.

Sign up for GitHub

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

Jump to bottom

Profile hardware - Draft Hardware Profile Submission #947

Open
wants to merge 115 commits into
base: profile-hardware
Choose a base branch
from
Open

Profile hardware - Draft Hardware Profile Submission #947

wants to merge 115 commits into from

Conversation

stevenc-stb
Copy link

This is the draft hardware submission. Please review and advise.

@stevenc-stb
Add Process Obect for HBOM
75be2c5 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Add files via upload
b111d39 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Add Hardware Class Profile
f7b92b0 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update Hardware.md
cdc9d0b 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update and rename xAxis.md to xAxisLength.md
a9c466c 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update and rename yAxis.md to yAxisLength.md
aee5e70 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update and rename zAxis.md to zAxisLength.md
b6d82c6 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update HBOMDimensions.md - Change ()Axis to ()AxisLength
6f33d08 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update HBOMDimensions.md Fix Capulization
4165756 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Delete model/Hardware/Vocabularies/processType.md
2c56078 
Need to move to model/Core/Vocabularies/processType.md

Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Add processType to Core
9d5191e 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update Process.md
131f964 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update and rename type.md to typeOfProcess.md
f0dc396 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update Process.md
8a0bb7e 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Delete model/Hardware/Vocabularies/documentState.md
c930806 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Add Document State to the right place.
72bfbef 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update RelationshipType.md
3300866 
Add new Relationship Types 

Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update RelationshipType.md
47944eb 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update RelationshipType.md
e724862 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update physical.md
719c075 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update status.md
2c37e9b 
Improved clarity 

Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update RelationshipType.md
25ff6f6 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update informationElementList.md
00d0f4d 
Improved Clarity. 

Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update physical.md
b35b37c 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update virtualFlag.md
ce6ba53 
Clarity

Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update virtualFlag.md
5dbf526 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update coordinateOrientationType.md
e1427b2 
Fix coordinateOrientationType 

Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Delete model/Hardware/Vocabularies/processType.md
89c926c 
Moved to model/Core/Vocabularies/processType.md

Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Add files via upload
6db3db4 
move to /Core/Vocabularies/processType.md 

Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@bact bact added the Profile:Hardware Hardware Profile and related matters label Dec 21, 2024
stevenc-stb and others added 3 commits January 14, 2025 10:11
@stevenc-stb
Update physical.md
63cbcf9 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb @bact
Apply suggestions from code review
06a91df 
Co-authored-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update HBOMPhysical.md
e08643a 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
bact
bact reviewed Jan 14, 2025
View reviewed changes
model/Hardware/Properties/mass.md Outdated Show resolved Hide resolved
model/Hardware/Classes/HBOMPhysical.md Outdated Show resolved Hide resolved
bact
bact requested changes Jan 14, 2025
View reviewed changes
model/Hardware/Properties/physical.md Outdated Show resolved Hide resolved
stevenc-stb and others added 2 commits January 14, 2025 10:30
@stevenc-stb @bact
Update model/Hardware/Properties/mass.md
39a3b1e 
Co-authored-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb @bact
Apply suggestions from code review
6c4934c 
Co-authored-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
zvr
zvr requested changes Jan 14, 2025
View reviewed changes
Copy link
Member

@zvr zvr left a comment

Choose a reason for hiding this comment

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

Looking forward to the Tech call, to have some of this explained.

model/Core/Classes/Process.md
@@ -0,0 +1,32 @@
SPDX-License-Identifier: Community-Spec-1.0

# Process
Copy link
Member

Choose a reason for hiding this comment

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

I think we agreed on renaming this to DefinedProcess or ProcessPlan or something...

model/Core/Classes/Action.md Outdated Show resolved Hide resolved
model/Core/Classes/Action.md Outdated Show resolved Hide resolved
model/Core/Classes/Action.md Outdated Show resolved Hide resolved
model/Core/Classes/Process.md Outdated Show resolved Hide resolved
model/Core/Properties/version.md
@@ -0,0 +1,17 @@
SPDX-License-Identifier: Community-Spec-1.0

# version
Copy link
Member

Choose a reason for hiding this comment

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

processVersion

model/Core/Vocabularies/DocumentState.md

## Summary

The state of a document is defined by the enumeration.
Copy link
Member

Choose a reason for hiding this comment

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

What is a "document" ?

model/Hardware/Properties/version.md
@@ -0,0 +1,17 @@
SPDX-License-Identifier: Community-Spec-1.0

# version
Copy link
Member

Choose a reason for hiding this comment

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

hardwareVersion

model/Hardware/Classes/HBOMDimensions.md
@@ -0,0 +1,39 @@
SPDX-License-Identifier: Community-Spec-1.0

# HBOMDimensions
Copy link
Member

Choose a reason for hiding this comment

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

Why is this a separate class instead of these being properties of HBOMPhysical ?
And what does HBOM mean, anyway?

model/Hardware/Classes/PhysicalHardware.md
@@ -0,0 +1,24 @@
SPDX-License-Identifier: Community-Spec-1.0

# PhysicalHardware
Copy link
Member

Choose a reason for hiding this comment

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

What's the difference between PhysicalHardware and HBOMPhysical ?

@stevenc-stb
Update Action.md
c869ded 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update Process.md
4839548 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update actionEndTime.md
b52035d 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@bact
Copy link
Collaborator

bact commented Jan 14, 2025 •
edited
Loading

Note: Currently this PR failed the spec-parser because there are some headers without content.

("Properties" header in model/Hardware/Classes/InstantiatedProcess.md and model/Hardware/Classes/VirtualHardware.md )

It pass the CI now by removing the empty Properties sections temporarily (please put them back when you see fit).
The rest of the PR looks good and spec-parser emits no further error messages.

@stevenc-stb
Update actionStartTime.md
a852b74 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update centerOfMass.md
28b5f79 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update physical.md
049eb19 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
bact added a commit to bact/spec-parser that referenced this pull request Jan 14, 2025
@bact
Display error message when cannot parse Header and Content
72e89f1 
To let the user knows more about why there's an error.

For example, in a case similar to spdx/spdx-3-model#947 (comment)

Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact bact mentioned this pull request Jan 14, 2025
Open
bact
bact reviewed Jan 14, 2025
View reviewed changes
model/Core/Vocabularies/DocumentState.md

## Description

Documents states vary by state. Enumerations are used to define the state.
Copy link
Collaborator

Choose a reason for hiding this comment

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

A note from Tech Call 2025-01-14, this vocab is something to do with "readiness" of a document.

bact and others added 3 commits January 14, 2025 19:03
@bact
Remove an extra blank line in DocumentState.md
8ff64b5 
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>

Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@stevenc-stb
Update VirtualHardware.md
906cb31 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
@stevenc-stb
Update VirtualHardware.md
27c2b30 
Signed-off-by: stevenc-stb <steven@smarttalkbeacon.com>
bact
bact reviewed Jan 15, 2025
View reviewed changes
model/Hardware/Classes/InstantiatedProcess.md Outdated Show resolved Hide resolved
model/Hardware/Classes/VirtualHardware.md Outdated Show resolved Hide resolved
bact added 2 commits January 15, 2025 05:08
@bact
Update model/Hardware/Classes/InstantiatedProcess.md
7995374 
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact
Update model/Hardware/Classes/VirtualHardware.md
b7edb59 
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
bact
bact reviewed Jan 15, 2025
View reviewed changes
model/Hardware/Classes/InstantiatedProcess.md Outdated Show resolved Hide resolved
model/Hardware/Classes/VirtualHardware.md Outdated Show resolved Hide resolved
bact added 2 commits January 15, 2025 05:11
@bact
Update model/Hardware/Classes/InstantiatedProcess.md
288da09 
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact
Update model/Hardware/Classes/VirtualHardware.md
58a9394 
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact bact self-requested a review January 15, 2025 05:15
@bact bact self-requested a review January 15, 2025 05:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@zvr zvr zvr requested changes

@goneall goneall Awaiting requested review from goneall

@kestewart kestewart Awaiting requested review from kestewart

@bact bact Awaiting requested review from bact

Assignees
No one assigned
Labels
Profile:Hardware Hardware Profile and related matters
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@stevenc-stb @bact @zvr