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

Document additional dependencies (Infra) #1705

Merged
merged 1 commit into from
Jan 31, 2025

Conversation

pesader
Copy link
Contributor

@pesader pesader commented Jan 31, 2025

Description

The pkg-config and libsystemd-dev packages are needed for building checkbox, but they are not in the documentation. Without them, the command "python3 -m pip install -e ." (which appears later in the documentation) fails.

Without pkg-config, I got this error:

      FileNotFoundError: [Errno 2] No such file or directory: 'pkg-config'
      [end of output]
  
  note: This error originates from a subprocess, and is likely not a problem with pip.
error: subprocess-exited-with-error

Without libsystemd-dev, I got this error:

  × Getting requirements to build wheel did not run successfully.
  │ exit code: 1
  ╰─> [12 lines of output]
      Cannot find libsystemd or libsystemd-journal:
      
      Package libsystemd was not found in the pkg-config search path.
      Perhaps you should add the directory containing `libsystemd.pc'
      to the PKG_CONFIG_PATH environment variable
      Package 'libsystemd', required by 'virtual:world', not found
      
      Package libsystemd-journal was not found in the pkg-config search path.
      Perhaps you should add the directory containing `libsystemd-journal.pc'
      to the PKG_CONFIG_PATH environment variable
      Package 'libsystemd-journal', required by 'virtual:world', not found
      
      [end of output]
  
  note: This error originates from a subprocess, and is likely not a problem with pip.
error: subprocess-exited-with-error

To solve this, add them to the command that installs system packages for checkbox development.

Documentation

This contribution makes changes to the contributor's documentation itself, in the CONTRIBUTORS.md file.

The pkg-config and libsystemd-dev packages are needed for building
checkbox, but they are not in the documentation. Without them, the
command "python3 -m pip install -e ." (which appears later in the
documentation) fails. To solve this, add them to the command that
installs system packages for checkbox development.
Copy link
Collaborator

@Hook25 Hook25 left a comment

Choose a reason for hiding this comment

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

+1, ty

@Hook25 Hook25 merged commit 4ff2b66 into canonical:main Jan 31, 2025
5 of 6 checks passed
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