Skip to content

Commit

Permalink
sagemathgh-36511: Exclude symlinks from vscode search config via glob…
Browse files Browse the repository at this point in the history
… pattern

    
As requested in
sagemath#36380 (comment) and
cherry-picked from there.

<!-- ^^^^^
Please provide a concise, informative and self-explanatory title.
Don't put issue numbers in there, do this in the PR body below.
For example, instead of "Fixes sagemath#1234" use "Introduce new method to
calculate 1+1"
-->
<!-- Describe your changes here in detail -->

<!-- Why is this change required? What problem does it solve? -->
<!-- If this PR resolves an open issue, please link to it here. For
example "Fixes sagemath#12345". -->
<!-- If your change requires a documentation PR, please link it
appropriately. -->

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it
appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
<!-- Feel free to remove irrelevant items. -->

- [x] The title is concise, informative, and self-explanatory.
- [ ] The description explains in detail what this PR is about.
- [x] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation accordingly.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on
- sagemath#12345: short description why this is a dependency
- sagemath#34567: ...
-->

<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
    
URL: sagemath#36511
Reported by: Matthias Köppe
Reviewer(s): Tobias Diez
  • Loading branch information
Release Manager committed Oct 25, 2023
2 parents 4661842 + a848f1e commit b5d72ce
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 10 deletions.
15 changes: 8 additions & 7 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,14 @@
"src/**/*.so": true
},
"search.exclude": {
"build/pkgs/sagemath_categories/src": true,
"build/pkgs/sagemath_objects/src": true,
"build/pkgs/sagelib/src": true,
"pkgs/sage-conf_pypi/sage_root/build": true,
"pkgs/sagemath-categories/sage": true,
"pkgs/sagemath-objects/sage": true,
"pkgs/sagemath-standard/sage": true
// Exclude symbolic links into SAGE_ROOT/pkgs/
"build/pkgs/*/src": true,
// Exclude symbolic links into SAGE_ROOT/src/
"pkgs/sage-conf_conda/sage_root": true,
"pkgs/sage-conf_pypi/sage_root": true,
"pkgs/sage-docbuild/sage_docbuild": true,
"pkgs/sage-setup/sage_setup": true,
"pkgs/sagemath-*/sage": true
},
"python.testing.pytestEnabled": true,
"python.testing.pytestArgs": [
Expand Down
3 changes: 0 additions & 3 deletions src/doc/en/developer/packaging_sage_library.rst
Original file line number Diff line number Diff line change
Expand Up @@ -190,9 +190,6 @@ The technique of using symbolic links pointing into ``SAGE_ROOT/src``
has allowed the modularization effort to keep the ``SAGE_ROOT/src``
tree monolithic: Modularization has been happening behind the scenes
and will not change where Sage developers find the source files.
When adding a new distribution package that uses a symbolic link pointing into
``SAGE_ROOT/src``, please update ``search.exclude`` in
``SAGE_ROOT/.vscode/settings.json``.

Some of these files may actually be generated from source files with suffix ``.m4`` by the
``SAGE_ROOT/bootstrap`` script via the ``m4`` macro processor.
Expand Down

0 comments on commit b5d72ce

Please sign in to comment.