Uh oh!
There was an error while loading. Please reload this page.
add windows certificate store documentation - #261
Conversation
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Adds documentation for Windows Certificate Store support in wolfSSH and reorganizes the manual chapters to accommodate the new section.
Changes:
- Adds a new “Windows Certificate Store Integration” chapter documenting build requirements, APIs, configuration, and examples.
- Reorders/renames chapters for Notes/Licensing/Support/Updates/API reference sections.
- Updates MkDocs navigation and refreshes copyright years.
Reviewed changes
Copilot reviewed 7 out of 8 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
| wolfSSH/src/chapter09.md | Adds comprehensive Windows Certificate Store integration documentation. |
| wolfSSH/src/chapter10.md | Replaces Licensing content with Notes and Limitations section. |
| wolfSSH/src/chapter11.md | Moves Licensing content into its own chapter. |
| wolfSSH/src/chapter12.md | Moves Support and Consulting content into its own chapter. |
| wolfSSH/src/chapter13.md | Replaces previous API reference content with “wolfSSH Updates”. |
| wolfSSH/src/chapter14.md | Moves API reference content here and expands/updates it. |
| wolfSSH/mkdocs.yml | Updates site nav to new chapter ordering and names; updates copyright year. |
| wolfSSH/header.txt | Updates PDF footer copyright year. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
| **Return Values** | ||
| **int** – file descriptor | ||
| **WS_BAD_ARGUEMENT** |
There was a problem hiding this comment.
Correct the error code spelling from WS_BAD_ARGUEMENT to WS_BAD_ARGUMENT to match the actual enum name and avoid confusing users.
| **WS_BAD_ARGUEMENT** | |
| **WS_BAD_ARGUMENT** |
| **Return Values** | ||
| **WS_BAD_ARGUMENT** - returned if the parameter is NULL | ||
| **WS_SUCCES** - returns when everything has been correctly shutdown |
There was a problem hiding this comment.
The documented return code WS_SUCCES appears to be a typo and should be WS_SUCCESS (consistent with the rest of the API and enum list). As written, it documents a non-existent constant.
| **WS_SUCCES** - returns when everything has been correctly shutdown | |
| **WS_SUCCESS** - returns when everything has been correctly shutdown |
| wolfSSH_accept is called on the server side and waits for an SSH client to initiate the | ||
| SSH handshake. | ||
| wolfSSL_accept() works with both blocking and non-blocking I/O. When the underlying |
There was a problem hiding this comment.
This section is documenting wolfSSH_accept(), but the text references wolfSSL_accept(). That’s likely a copy/paste error and can mislead readers into thinking this is a wolfSSL API behavior/requirement. Consider changing the reference to wolfSSH_accept() for consistency with the surrounding text.
| wolfSSL_accept() works with both blocking and non-blocking I/O. When the underlying | |
| wolfSSH_accept() works with both blocking and non-blocking I/O. When the underlying |
| **See Also** | ||
| wolfSSH_wolfSSH_CTX_free() |
There was a problem hiding this comment.
The “See Also” reference wolfSSH_wolfSSH_CTX_free() does not match the function name documented below (wolfSSH_CTX_free()). This looks like an incorrect symbol name in the docs; updating it to wolfSSH_CTX_free() would prevent confusion and improve cross-referencing.
| wolfSSH_wolfSSH_CTX_free() | |
| wolfSSH_CTX_free() |
| renamed from “old” to “nw”. | ||
| ``` | ||
| #include <wolfssh/ssh.h> | ||
| int* wolfSSH_ChannelSend(WOLFSSH_CHANNEL* channel , |
There was a problem hiding this comment.
wolfSSH_ChannelSend() is documented as returning int*, which is very likely incorrect for a “bytes sent / error code” return value API (should be an int). This is a user-facing API reference error and should be corrected to prevent incorrect usage.
| int* wolfSSH_ChannelSend(WOLFSSH_CHANNEL* channel , | |
| int wolfSSH_ChannelSend(WOLFSSH_CHANNEL* channel , |
| #include <wolfssh/wolfsftp.h> | ||
| WS_SFTPNAME* wolfSSH_SFTP_LS(WOLFSSH* ssh , char* dir ); | ||
| #include <wolfssh/ssh.h> | ||
| WOLFSSH_CHANNEL* wolfSSH_ChannelFwdNew(WOLFSSH* ssh , |
There was a problem hiding this comment.
This code block appears under the wolfSSH_ChannelNext() heading but shows the prototype for wolfSSH_ChannelFwdNew(...) instead of wolfSSH_ChannelNext(...). This mismatch will confuse readers and should be updated so the snippet matches the documented function.
| WOLFSSH_CHANNEL*wolfSSH_ChannelFwdNew(WOLFSSH* ssh , | |
| WOLFSSH_CHANNEL*wolfSSH_ChannelNext(WOLFSSH* ssh , |
| For information regarding wolfSSL products, questions regarding licensing, or general comments, please contact wolfSSL by emailing **info@wolfssl.com**. | ||
| ### Bugs Reports and Support Issues |
There was a problem hiding this comment.
The heading “Bugs Reports…” should be “Bug Reports…” (or “Bug Reports and Support Issues”) for correct grammar.
| ### Bugs Reports and Support Issues | |
| ### Bug Reports and Support Issues |
Documentation for (wolfSSL/wolfssh#900)