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

add more breadcrumbs for how to use remote packages. documentation change only. #9386

Merged
merged 71 commits into from
Dec 2, 2023
Merged
Changes from all commits
Commits
Show all changes
71 commits
Select commit Hold shift + click to select a range
18e39bf
add more breadcrumbs for how to use remote packages.
julialongtin Oct 31, 2023
00e2718
Hackage should be capitalized
julialongtin Nov 1, 2023
46da089
Update doc/cabal-project.rst
julialongtin Nov 2, 2023
a5f0253
Update doc/cabal-project.rst
julialongtin Nov 2, 2023
88768cb
Update doc/cabal-project.rst
julialongtin Nov 2, 2023
03ec810
Update doc/cabal-project.rst
julialongtin Nov 2, 2023
9dee2a1
Update doc/cabal-project.rst
julialongtin Nov 2, 2023
6262ddc
wrap.
julialongtin Nov 3, 2023
ad6d340
Update doc/cabal-project.rst
julialongtin Nov 4, 2023
99a3790
clarify english, and follow a linguistic pattern better.
julialongtin Nov 26, 2023
0aa249b
Update doc/cabal-project.rst
julialongtin Dec 2, 2023
547d4e1
doc: render math with HTML to make it selectable (fix #8453) (#9361)
ulysses4ever Nov 1, 2023
8a06e9e
Avoid double space in "Executing install plan ..."
philderbeast Oct 28, 2023
f77f140
Add a change log entry for double space avoidance
philderbeast Oct 30, 2023
a70382f
Ignore CmmSourcesExe Demo
philderbeast Aug 21, 2023
37ab658
[cabal-7825] Implement external command system
yvan-sraka Jun 21, 2023
0425f5e
Bump to latest dependencies for GHC 9.8.1
andreasabel Oct 25, 2023
d140693
cabal.project: clean out obsolete `allow-newer`s
andreasabel Oct 31, 2023
f9d472e
update GH validate workflow to ghc 9.2.8, 9.4.7, 9.6.3
juhp Nov 3, 2023
315fd08
Revert #3639 (Don't pass -package-db and -package flags to --abi-hash…
andreabedini Nov 4, 2023
c7f0909
Use the newer haskell-actions organisation
philderbeast Oct 30, 2023
902c919
Restructure Cabal documentation top-level parts
malteneuss Oct 28, 2023
9103d5e
Rename master_doc to root_doc (changed in version 4.0 of Sphynx)
malteneuss Oct 28, 2023
4ce4e48
Add instance Ord for Field, FieldLine, SectionArg and Name
Bodigrim Oct 31, 2023
c4d0a03
Do not run CI for documentation changes
BinderDavid Oct 20, 2023
653e874
Move Backpack section to user guides
Nov 6, 2023
c79eeb1
Remove TBW virtual modules section
Nov 6, 2023
413f336
Add reinstall test to LinkerOptions/NonignoredConfigs
philderbeast Oct 22, 2023
4c63a98
Record install options
philderbeast Nov 6, 2023
13247e8
Reject index-states after last known index-state (#8944)
jasagredo Nov 9, 2023
9a27b91
Note how to do "not equal" with constraints
philderbeast Oct 30, 2023
3c8d79b
Use comma with then
philderbeast Oct 30, 2023
4e65005
Use narrow rather than upset
philderbeast Oct 30, 2023
591e49b
Say something about hackage deprecations
philderbeast Oct 30, 2023
f382433
Fix AutogenModulesToggling test
mpickering Nov 6, 2023
811ba61
Require version 3,11 of Cabal to support --semaphore flag
mpickering Aug 30, 2023
78c1c24
Add dependencies used by `PackageTests` to exe:cabal-tests
fendor Nov 4, 2023
d36b9f1
Use Paths_cabal_install for cabal-install version number (#9421)
Kleidukos Nov 11, 2023
2ca9349
Document --profiling-detail in setup-commands.
AndreasPK Nov 2, 2023
914b090
Add test requirement to PR template
ffaf1 Nov 6, 2023
cede294
A 'cabal path' command. (#8879)
athas Nov 13, 2023
0d382b1
Reimplement `cabal check` (#8427)
ffaf1 Nov 13, 2023
c3a92e5
ci: Enable windows tests for 9.6.3
mpickering Nov 8, 2023
8a0a0f0
testsuite: Be explicit about runtime test dependencies
mpickering Nov 13, 2023
6df6a48
hurd: Enable using $ORIGIN in RPATH
sthibaul Nov 13, 2023
5a21d99
Fix the platform string for GNU/Hurd
sthibaul Nov 12, 2023
09a09df
Fix configuation of ldProgram
erikd Sep 18, 2023
db33242
Chain configuration of ldProgram
erikd Sep 18, 2023
e406c64
Use linker capability detection to improve linker use
erikd Nov 15, 2023
2aa76b5
add `merge+no rebase`
geekosaur Nov 8, 2023
71b7a6f
Add support for 64-bit SPARC as a separate architecture
glaubitz Nov 14, 2023
30e6ea7
Remove debug-conflict-sets flag from solver package
grayjay Nov 11, 2023
893dcdb
Finish improvements to the CI configuration for documentation changes…
BinderDavid Nov 21, 2023
f6a46db
formatting: Add style-commit makefile target
mpickering Nov 8, 2023
1c55df4
Fix assertion failure when combining build-tool-depends and --enable-…
mpickering Nov 14, 2023
93c5abf
testsuite: Improve error message in findDependencyInStore
mpickering Nov 14, 2023
d24a35a
Only move code to Simple/GHC/Build*
philderbeast Nov 6, 2023
2d5002f
CPP mingw32_HOST_OS for more imports
philderbeast Nov 6, 2023
4416f86
cabal-install-solver: fix pkgconf 1.9 --modversion regression
juhp Nov 3, 2023
ce064fb
External commands: Add tests for #9402 #9403 #9404
mpickering Nov 3, 2023
245e68a
Finish off the external commands feature
mpickering Nov 6, 2023
2e2ac78
Use Base16 hash for script path.
jasagredo Nov 18, 2023
ac463a0
Migrate to haskell-actions/setup
andreabedini Nov 22, 2023
a4f0349
testsuite: Introduce Cabal-tests library for common testsuite functions
mpickering Nov 16, 2023
357ae58
GHC 9.8 compat: pacify -Wx-partial
ulysses4ever Oct 15, 2023
487b0ef
GHC 9.8 compat: update hashes of data structures as computed by Struc…
ulysses4ever Oct 16, 2023
ebe3949
GHC 9.8 compat: bump base, update Unknown GHC
ulysses4ever Oct 13, 2023
2b37781
CI: GHC 9.8
ulysses4ever Nov 10, 2023
a57001c
merge master
julialongtin Dec 2, 2023
395b473
Hackage should be capitalized
julialongtin Nov 1, 2023
fc4ce65
Merge branch 'master' into juri_more_breadcrumbs
julialongtin Dec 2, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions doc/cabal-project-description-file.rst
Original file line number Diff line number Diff line change
Expand Up @@ -193,9 +193,11 @@ Formally, the format is described by the following BNF:
Specifying Packages from Remote Version Control Locations
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Starting with Cabal 2.4, there is now a stanza
``source-repository-package`` for specifying packages from an external
version control.
Since version 2.4, the ``source-repository-package`` stanza allows for
specifying packages in a remote version control system that cabal should
consider during package retrieval. This allows use of a package from a
remote version control system, rather than looking for that package in
Hackage.

.. code-block:: cabal

Expand All @@ -218,8 +220,11 @@ version control.
tag: e76fdc753e660dfa615af6c8b6a2ad9ddf6afe70
post-checkout-command: autoreconf -i

cabal-install 3.4 sdists the ``source-repository-package`` repositories and uses resulting tarballs as project packages.
This allows sharing of packages across different projects.
Since version 3.4, cabal-install creates tarballs for each package coming
from a ``source-repository-package`` stanza (effectively applying cabal
sdists to such packages). It gathers the names of the packages from the
appropriate .cabal file in the version control repository, and allows
their use just like Hackage or locally defined packages.

.. cfg-field:: type: VCS kind

Expand All @@ -229,7 +234,7 @@ This allows sharing of packages across different projects.

.. cfg-field:: subdir: subdirectory list

Use one or more subdirectories of the repository.
Look in one or more subdirectories of the repository for cabal files, rather than the root.

.. cfg-field:: post-checkout-command: command

Expand Down
Loading