Skip to content

do not hint users to add dynamic library suffix #125

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

Merged
merged 1 commit into from
Jul 3, 2025

Conversation

usamoi
Copy link
Collaborator

@usamoi usamoi commented Jul 3, 2025

PostgreSQL is smart in areas where it's not particularly smart.

Copy link

vercel bot commented Jul 3, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
pgvecto-rs-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 3, 2025 1:27pm

@usamoi usamoi requested a review from Copilot July 3, 2025 13:27
@usamoi usamoi merged commit b32ab1f into tensorchord:main Jul 3, 2025
4 checks passed
Copy link
Contributor

@Copilot 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 removes explicit dynamic library suffixes from shared_preload_libraries examples and standardizes restart instructions across all installation methods.

  • Dropped .so, .dylib, and .dll hints in ALTER SYSTEM SET commands
  • Added “restart the PostgreSQL cluster” step after configuration
  • Clarified environment variable guidance for setting CC
Comments suppressed due to low confidence (2)

src/vectorchord/getting-started/installation.md:83

  • [nitpick] Starting the sentence with “And then” is informal; consider rephrasing to “Then restart the PostgreSQL cluster.” for consistency and clarity.
2. Configure your PostgreSQL by modifying the `shared_preload_libraries` to include the extension. And then restart the PostgreSQL cluster.

src/vectorchord/getting-started/installation.md:206

  • [nitpick] Clarify grammar by specifying “the path to your Clang executable” instead of “path of your Clang.”
If your Clang executable is not named `clang` or is not in `PATH`, please set the environment variable `CC` to path of your Clang.

2. Configure your PostgreSQL by modifying the `shared_preload_libraries` to include the extension. And then restart the PostgreSQL cluster.

```sh
psql -U postgres -c 'ALTER SYSTEM SET shared_preload_libraries = "vchord"'
Copy link
Preview

Copilot AI Jul 3, 2025

Choose a reason for hiding this comment

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

The PGXN section omits a command to restart the PostgreSQL service after updating shared_preload_libraries. Add a restart step (e.g., sudo systemctl restart postgresql.service) so the change takes effect.

Suggested change
psql -U postgres -c 'ALTER SYSTEM SET shared_preload_libraries = "vchord"'
psql -U postgres -c 'ALTER SYSTEM SET shared_preload_libraries = "vchord"'
sudo systemctl restart postgresql.service

Copilot uses AI. Check for mistakes.

@@ -163,51 +174,26 @@ cd VectorChord
git checkout "0.4.3"
```

2. Install a C compiler and Rust. For GCC, the version must be 14 or higher. For Clang, the version must be 16 or higher. Other C compilers are not supported. For Rust, the version must be the same as that recorded in `rust-toolchain.toml`.
2. Install a C compiler and Rust. For Clang, the version must be 16 or higher. For GCC, the version must be 14 or higher. Other C compilers are not supported, and we prefer and recommend using Clang. For Rust, the version must be the same as that recorded in `rust-toolchain.toml`.
Copy link
Preview

Copilot AI Jul 3, 2025

Choose a reason for hiding this comment

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

[nitpick] The phrase “prefer and recommend” is redundant. Simplify to “we recommend using Clang.” to improve readability.

Suggested change
2. Install a C compiler and Rust. For Clang, the version must be 16 or higher. For GCC, the version must be 14 or higher. Other C compilers are not supported, and we prefer and recommend using Clang. For Rust, the version must be the same as that recorded in `rust-toolchain.toml`.
2. Install a C compiler and Rust. For Clang, the version must be 16 or higher. For GCC, the version must be 14 or higher. Other C compilers are not supported, and we recommend using Clang. For Rust, the version must be the same as that recorded in `rust-toolchain.toml`.

Copilot uses AI. Check for mistakes.

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.

1 participant