Skip to content

Conversation

@bewithgaurav
Copy link
Collaborator

Work Item / Issue Reference

AB#<WORK_ITEM_ID>

GitHub Issue: #204


Summary

This pull request updates installation instructions and error messaging to improve the setup experience for Linux users. The most important changes include expanding the list of required packages in the documentation for various Linux distributions and clarifying error messages to direct users to the documentation for troubleshooting.

Documentation improvements:

  • Expanded the list of required system packages in the README.md for Alpine, Debian/Ubuntu, RHEL/CentOS/Fedora, and added instructions for SUSE/openSUSE to ensure all necessary dependencies are installed before running pip install mssql-python.

Error handling improvements:

  • Updated the error message in ddbc_bindings.cpp to direct Linux users to the documentation for dependency installation, instead of referencing only the libltdl7 package.

Copilot AI review requested due to automatic review settings August 29, 2025 07:40
@github-actions github-actions bot added the pr-size: small Minimal code update label Aug 29, 2025
Copy link
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 fixes Linux installation documentation and error messages for Kerberos dependencies. The changes improve the setup experience by providing comprehensive dependency lists for various Linux distributions and updating error messages to direct users to documentation.

  • Updated README.md with expanded package lists for Alpine, Debian/Ubuntu, RHEL/CentOS/Fedora distributions and added SUSE/openSUSE instructions
  • Modified error message in ddbc_bindings.cpp to reference documentation instead of specific package names
  • Added Kerberos-related dependencies (krb5-dev, libkrb5-3, libgssapi-krb5-2, krb5-libs) across distributions

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
README.md Expanded Linux dependency installation instructions with Kerberos packages for multiple distributions
mssql_python/pybind/ddbc_bindings.cpp Updated error message to reference documentation instead of specific package

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@github-actions github-actions bot added pr-size: small Minimal code update and removed pr-size: small Minimal code update labels Aug 29, 2025
@bewithgaurav bewithgaurav changed the title FIX: README - Kerberos Dependencies on Linux DOC: README - Kerberos Dependencies on Linux Aug 29, 2025
@github-actions github-actions bot added pr-size: small Minimal code update and removed pr-size: small Minimal code update labels Aug 29, 2025
Copy link
Contributor

@sumitmsft sumitmsft left a comment

Choose a reason for hiding this comment

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

Added a comment

@github-actions github-actions bot added pr-size: small Minimal code update and removed pr-size: small Minimal code update labels Aug 29, 2025
@bewithgaurav bewithgaurav merged commit 7ec0e7d into main Aug 29, 2025
18 checks passed
@bewithgaurav bewithgaurav linked an issue Sep 8, 2025 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pr-size: small Minimal code update

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Unable to use in docker image

4 participants