Skip to content

docs: explain cabal update repository index state - #12448

Open
KeuqS wants to merge 2 commits into
haskell:masterfrom
KeuqS:docs/cabal-update-repository-state
Open

KeuqS wants to merge 2 commits into
haskell:masterfrom
KeuqS:docs/cabal-update-repository-state

Conversation

@KeuqS

@KeuqS KeuqS commented Oct 11, 2026

Copy link
Copy Markdown

Summary

  • Document the REPO[,INDEX-STATE] argument accepted by cabal update.
  • Explain Unix timestamp, ISO 8601 UTC timestamp, and HEAD forms.
  • Clarify that the supplied index state selects the global package index revision and is distinct from a project-local index-state.

Verification

  • Compared the user guide with doc/cmd-v2-help/update.txt to keep the syntax and examples aligned.
  • Documentation-only change; no runtime code or tests are affected.

Checklist

  • This PR does not modify behaviour or interface.
  • The documentation has been updated.

Fixes #12447

@KeuqS

KeuqS commented Oct 12, 2026

Copy link
Copy Markdown
Author

Updated the branch with current master in commit cd0052e so the PR is no longer out of date. The documentation change remains a single-file, 13-line addition and git diff --check passes; the newly triggered documentation checks are now running.

@Mikolaj Mikolaj left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you.

@ffaf1 ffaf1 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Many thanks.

@zlonast zlonast added merge me Tell Mergify Bot to merge squash+merge me Tell Mergify Bot to squash-merge and removed merge me Tell Mergify Bot to merge labels Oct 15, 2026
@mergify mergify Bot added the ready and waiting Mergify is waiting out the cooldown period label Oct 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ready and waiting Mergify is waiting out the cooldown period squash+merge me Tell Mergify Bot to squash-merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

cabal update underdocumented

4 participants