Skip to content

docs: add missing API types documentation#1052

Merged
igaw merged 1 commit intolinux-nvme:masterfrom
Arno500:patch-1
Aug 22, 2025
Merged

docs: add missing API types documentation#1052
igaw merged 1 commit intolinux-nvme:masterfrom
Arno500:patch-1

Conversation

@Arno500
Copy link
Copy Markdown
Contributor

@Arno500 Arno500 commented Aug 21, 2025

The api-types.h file was not included during documentation generation, thus not being available in the online doc. It was containing some important structures used as arguments for some function calls.

@igaw
Copy link
Copy Markdown
Collaborator

igaw commented Aug 22, 2025

Looks good, though could you update the commit message:

 WARNING: Possible unwrapped commit description (prefer a maximum 75 chars per line)
#6:
The api-types.h file was not included during documentation generation, thus not being available in the online doc. It was containing some important structures used as arguments for some function calls.
Error: WARNING: Possible unwrapped commit description (prefer a maximum 75 chars per line)


ERROR: Missing Signed-off-by: line(s)
Error: ERROR: Missing Signed-off-by: line(s)

Thanks!

@Arno500
Copy link
Copy Markdown
Contributor Author

Arno500 commented Aug 22, 2025

Fixed!

@igaw
Copy link
Copy Markdown
Collaborator

igaw commented Aug 22, 2025

Ah checkpatch will still complain, because it expects a 'Signed-off-by: [email address]'

If you don't want to add your email just add your github handle that is also okay I suppose :)

The api-types.h file was not included
during documentation generation,
thus not being available in the online doc.
It was containing some important structures
used as arguments for some function calls.

Signed-off-by: Arno DUBOIS <[email protected]>
@Arno500
Copy link
Copy Markdown
Contributor Author

Arno500 commented Aug 22, 2025

Woops my bad, missed the second warning :/
Should be good now!

@igaw igaw merged commit 32560ea into linux-nvme:master Aug 22, 2025
12 checks passed
@igaw
Copy link
Copy Markdown
Collaborator

igaw commented Aug 22, 2025

Thanks!

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.

2 participants