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

Add vs2019 documentation #19

Merged
merged 8 commits into from
Mar 25, 2024
Merged

Add vs2019 documentation #19

merged 8 commits into from
Mar 25, 2024

Conversation

herve-er
Copy link
Contributor

Documentation for VS2019 debugging.

@herve-er herve-er requested a review from a team as a code owner March 25, 2024 09:31
@ClementKunz ClementKunz force-pushed the Add-VS2019-documentation branch from 3a30a85 to 1027696 Compare March 25, 2024 10:16
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

@ClementKunz ClementKunz merged commit ce6881d into develop Mar 25, 2024
3 checks passed
@ClementKunz ClementKunz deleted the Add-VS2019-documentation branch March 25, 2024 10:24
- [VS2019](#using-Visual-Studio-2019)
- [Windows extension](#windows-Extension)
- [Project setup](#project-Setup)
- [Cmake configuration](#cmake-Configuration)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- [Cmake configuration](#cmake-Configuration)
- [CMake configuration](#cmake-Configuration)


To build in Debug mode, you'll need to build and deploy the Windows extension first.

1. Open the kDriveExt solution located at "F:\Projects\desktop-kDrive\extensions\windows\cfapi".
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
1. Open the kDriveExt solution located at "F:\Projects\desktop-kDrive\extensions\windows\cfapi".
1. Open the `kDriveExt` solution located at `F:\Projects\desktop-kDrive\extensions\windows\cfapi`.

Copy link
Contributor

Choose a reason for hiding this comment

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

We may write somewhere that we assumed the sources are located in F:\Projects and that this might need to be adapted depending on the choice of the source location.


1. Open the kDriveExt solution located at "F:\Projects\desktop-kDrive\extensions\windows\cfapi".
2. In the post-build events of the VFS projects, navigate to "Right click on vfs project" >> "Properties" >> "Configuration properties" >> "Build events" >> "Post-build events".
3. Modify "F:\Projects\" to match your path. The last two paths are outputs of the global projects; keep them for later steps.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
3. Modify "F:\Projects\" to match your path. The last two paths are outputs of the global projects; keep them for later steps.
3. Modify `F:\Projects\` to match your path. The last two paths are outputs of the global projects; keep them for later steps.

Copy link
Contributor

Choose a reason for hiding this comment

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

I would use the code-style to display file paths on every turn. Let's see il all reviewers agree.

3. Modify "F:\Projects\" to match your path. The last two paths are outputs of the global projects; keep them for later steps.
4. Save and close the properties window.

Select "Debug x64" and deploy. Repeat the same steps for "Release x64".
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Select "Debug x64" and deploy. Repeat the same steps for "Release x64".
Select `Debug x64` and deploy. Repeat the same steps for `Release x64`.

Copy link
Contributor

Choose a reason for hiding this comment

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

Let's see if there is a consensus about the suggested changes.

```
You may need to adjust paths based on your installation.

Save (CTRL + S). CMake will automatically run in the output window; ensure no errors occur.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Save (CTRL + S). CMake will automatically run in the output window; ensure no errors occur.
Save (CTRL + S). CMake will automatically run in the output window; check no errors occur.

Copy link
Contributor

Choose a reason for hiding this comment

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

If errors occur, are there some indications as how to fix them?


Save (CTRL + S). CMake will automatically run in the output window; ensure no errors occur.

### Sync-exclude.lst
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
### Sync-exclude.lst
### The file `sync-exclude.lst`

Copy link
Contributor

Choose a reason for hiding this comment

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

I thought CMake was installing this file automatically. Did something change?


Select CMake targets.

Right-click on the Kdrive (executable) >> Debug >> Kdrive.exe (bin\kDrive.exe).
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this really "Kdrive" and not kDrive?

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.

3 participants