Skip to content

[WIP] Fix windows developer doc.#4227

Open
rasapala wants to merge 1 commit into
mainfrom
doc_update
Open

[WIP] Fix windows developer doc.#4227
rasapala wants to merge 1 commit into
mainfrom
doc_update

Conversation

@rasapala
Copy link
Copy Markdown
Collaborator

🛠 Summary

windows docs issues.

🧪 Checklist

  • Unit tests added.
  • The documentation updated.
  • Change follows security best practices.
    ``

Copilot AI review requested due to automatic review settings May 20, 2026 14:47
@rasapala rasapala changed the title [WIP] Fix command [WIP] Fix windows developer doc. May 20, 2026
@rasapala rasapala added the WIP Do not merge until resolved label May 20, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the Windows developer documentation to correct the example command used when passing optional parameters during the windows_build.bat compilation step.

Changes:

  • Fix the optional-arguments example to call windows_build.bat (instead of windows_install_build_dependencies.bat) in the compile section.
Comments suppressed due to low confidence (1)

docs/windows_developer_guide.md:85

  • The --integrity argument is documented as "flag to 0 or 1", but windows_build.bat treats it as a presence/absence switch (IF "%~4"=="--integrity"). Please update the description to reflect that no numeric value is passed (and clarify what integrity checks/config it enables).
windows_build.bat my_dir_on_c --with_python --with_tests --integrity

[arg1] This way you can change default dependency location directory to c:\my_dir_on_c
[arg2] --with_python - this will build the ovms.exe with python dependency and support for python chat templates for GENAI LLM
[arg3] --with_tests - this will also build ovms_test.exe target
[arg4] --integrity - Add the compilation integrity flag to 0 or 1 - set the additional integritycheck compilation flag when compiling dependencies

</details>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

WIP Do not merge until resolved

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants