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

Path for aw-server-rust executable doesn't match the docs #145

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Game4Move78
Copy link

@Game4Move78 Game4Move78 commented Feb 3, 2025

When running make build as per the docs it stores in target release not package. The basename of the executable is also aw-server not aw-server-rust.

Related to ActivityWatch/aw-server-rust#500


Important

Update installing-from-source.rst to correct the Rust server executable path and name.

  • Documentation:
    • Update installing-from-source.rst to correct the path for the Rust server executable from aw-server-rust/target/package/aw-server-rust to aw-server-rust/target/release/aw-server.

This description was created by Ellipsis for 6f6e5c8. It will automatically update as commits are pushed.

Copy link

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

👍 Looks good to me! Reviewed everything up to 6f6e5c8 in 21 seconds

More details
  • Looked at 13 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 2 drafted comments based on config settings.
1. src/installing-from-source.rst:107
  • Draft comment:
    Updated path & binary name now match the build output. Confirm that users see the correct 'target/release/aw-server'.
  • Reason this comment was not posted:
    Marked as duplicate.
2. src/installing-from-source.rst:107
  • Draft comment:
    Good update – the command now correctly points to target/release and uses the filename 'aw-server'. Ensure consistency across all related documentation (and consider noting any platform-specific executables, e.g. on Windows).
  • Reason this comment was not posted:
    Comment did not seem useful.

Workflow ID: wflow_3tuDJisfkipQnWmO


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

@ErikBjare
Copy link
Member

Seems we are not mentioning make package in this doc?

That's what puts it there as aw-server-rust: https://github.com/ActivityWatch/aw-server-rust/blob/master/Makefile#L86

The proper fix is probably to mention make package

@Game4Move78
Copy link
Author

Would also be good to mention make package in another section, but I think it shouldn't be presented as necessary. Assuming you don't want to to run all the steps for packaging and distribution, it would be nice if the docs mentioned that you can run aw-server-rust after make build, providing the correct command.

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