Add "status" command by lspitzner · Pull Request #2882 · haskell/cabal

lspitzner · 2015-10-22T17:24:30Z

The "status" command prints a summary over several
aspects of a cabal environment, such as the cabal
and ghc versions, the package and its components,
the package-databases, the sandbox etc.

This is a first proposition for such a command; i am thankful for any feedback.

One thing that might be worth changing is behaviour with flags: Currently there are a few sections printed always, and a few that can be toggled with the flags of the command. Perhaps it would be better to:
a) provide a flag for each section
b) without any flags, print a default set (e.g. the current default)
c) with at least one flag, print exactly the sections selected

I have not tested with compiler != ghc or os != linux.

lspitzner · 2015-10-22T18:09:23Z

i should add an example for the output from status: (i shortened some of the paths, i.e. $HOME and $SOMEPATH)

> cabal status
cabal-install version 1.23.0.0 compiled using version 1.23.0.0 of the Cabal library 
There is a different cabal (version 1.22.6.0) located in $HOME/.cabal/bin
configured compiler:
  ghc-7.10.2
local package:
  package "cabal-install" containing 3 component(s):
    executable "cabal"
    testsuite "unit-tests"
    testsuite "integration-tests"
sandbox: present in current directory:
  config  in $SOMEPATH/cabal/cabal-install/cabal.sandbox.config
  sandbox in $SOMEPATH/cabal/cabal-install/.cabal-sandbox
  sandbox package db in $SOMEPATH/cabal/cabal-install/.cabal-sandbox/x86_64-linux-ghc-7.10.2-packages.conf.d
package databases:
  12 packages in database $SOMEPATH/cabal/cabal-install/.cabal-sandbox
  25 packages in database /usr/lib/ghc-7.10.2

dcoutts · 2015-10-22T21:14:58Z

I've not looked at the detail of the patch, but in principle I think this is a good idea. I've been thinking of doing something like this for the nix-local-build branch where working out what the environment is is even more critical.

23Skidoo · 2015-10-22T21:19:24Z

UI bikeshedding: may be worth unifying this with cabal info, e.g. make cabal info without arguments print this information.

lspitzner · 2015-10-22T22:02:07Z

@23Skidoo true; when i inserted "status" to the cabal help output, the only command that i had no immediate association for the semantics was "info".

one more thing: the --all output (ellipses inserted by me):

> cabal status --all
cabal-install version 1.23.0.0 compiled using version 1.23.0.0 of the Cabal library 
There is a different cabal (version 1.22.6.0) located in $HOME/.cabal/bin
program versions:
  alex-3.1.4
  c2hs-0.26.1
  cpphs-1.19
  [..]
configured compiler:
  ghc-7.10.2
local package:
  package "cabal-install" containing 3 component(s):
    executable "cabal"
    testsuite "unit-tests"
    testsuite "integration-tests"
install plan:
  Cabal == 1.23.0.0
  array == 0.5.1.0
  base == 4.8.1.0
  [..]
sandbox: present in current directory:
  config  in $SOMEPATH/cabal/cabal-install/cabal.sandbox.config
  sandbox in $SOMEPATH/cabal/cabal-install/.cabal-sandbox
  sandbox package db in $SOMEPATH/cabal/cabal-install/.cabal-sandbox/x86_64-linux-ghc-7.10.2-packages.conf.d
package databases:
  12 packages in database $SOMEPATH/cabal/cabal-install/.cabal-sandbox
    (Cabal-1.23.0.0,
     HTTP-4000.2.20,
     mtl-2.2.1,
     network-2.6.2.1,
     [..]
  25 packages in database /usr/lib/ghc-7.10.2
    (Cabal-1.22.4.0,
     array-0.5.1.0,
     base-4.8.1.0,
     bin-package-db-0.0.0.0,
     [..]
package database checks:
  clean for database GlobalPackageDB
  clean for database UserPackageDB
  clean for database SpecificPackageDB "$SOMEPATH/cabal/cabal-install/.cabal-sandbox/x86_64-linux-ghc-7.10.2-packages.conf.d"

dcoutts · 2015-10-22T22:59:54Z

UI Bikeshedding, I see the info command as separate, it's sort of the equivalent of the hackage package page for packages, rather than "what is going on with my current project". So I'm quite happy with them being separate commands.

23Skidoo · 2015-10-23T02:59:37Z

Yes, that's a valid point. On the other hand, the distinction between status and info is not very intuitive.

lspitzner · 2015-10-24T10:56:20Z

How to i handle getExecutablePath with ghc-7.4.2 ?

23Skidoo · 2015-10-24T17:32:06Z

How to i handle getExecutablePath with ghc-7.4.2 ?

Doesn't importing Distribution.Client.Compat.ExecutablePath work for you?

lspitzner · 2015-10-24T22:39:41Z

@23Skidoo ah nice, i was not aware of that, thanks.

lspitzner · 2015-10-25T14:07:46Z

I did some testing under windows now, looks fine.

lspitzner · 2015-11-05T14:38:53Z

Are there further changes necessary before this can be merged, or is the main issue that somebody needs to find the time to review this?
(i can think of two potential items: 1) should be tested on macosx (sorry, i don't have that system available) 2) needs entry in some changelog)

23Skidoo · 2015-11-05T14:52:53Z

Cabal/Distribution/Text.hs

Why is this change needed?

23Skidoo · 2015-11-05T14:56:15Z

A changelog mention and some documentation would be nice.

Documentation lives under Cabal/doc, the changelog is cabal-install/changelog.

23Skidoo · 2015-11-05T14:57:29Z

Cabal/Distribution/Simple/Utils.hs

Please add a Haddock comment explaining what this function does.

23Skidoo · 2015-11-05T15:02:38Z

Added some comments. The patches look self-contained (as they should be), so I think this PR can go in.

23Skidoo · 2015-11-05T15:03:34Z

cabal-install/Distribution/Client/Status.hs

Please change to "There is a different 'cabal' executable (version".

BardurArantsson · 2015-11-14T15:08:22Z

Just a general comment: I think the individual commits should probably be squashed to a single commit before merge...?

23Skidoo · 2015-11-14T20:29:05Z

Yes, that would be nice given that some of the intermediate states don't build cleanly and there is a spurious merge commit.

lspitzner · 2015-11-15T15:24:51Z

Ok, i'll squash and rebase later.

lspitzner · 2015-11-15T20:56:28Z

I squashed all commits and rebased onto master.
The changes since the last commit roughly are:

Add more haddock/comments, as suggested.
Add changelog note.
Remove need for CPP in new module.
Change handling of flags, in the way i proposed in first comment above.

Questions

Should i be the maintainer of the "Status" module (as currently stated in the header)? i don't even have write access to the repo :p. I dont know how this should be handled.
The checkPackageDBs function that i added currently does not work when a specific compiler is configured. I don't really know why.
I don't really know where to add documentation. I'd guess somewhere in install-packages.markdown, but i have no idea where exactly. Should there be a new "setup status" paragraph? Why "setup"? Probably wrong? Please advice. (To be frank, the whole structure of the users-guide does not make much sense to me, but that is a different topic.)

23Skidoo · 2015-12-16T21:53:21Z

Should i be the maintainer of the "Status" module (as currently stated in the header)? i don't even have write access to the repo :p. I dont know how this should be handled.

I don't have a problem with it. I/someone can /cc you on PRs touching this module.

Should there be a new "setup status" paragraph? Why "setup"? Probably wrong? Please advice.

No, not setup status. That refers to Setup.hs scripts. Look at how the sandbox command is documented -- it doesn't have a Setup.hs equivalent either.

(To be frank, the whole structure of the users-guide does not make much sense to me, but that is a different topic.)

Yes, it needs to be reorganised.

lspitzner · 2016-02-23T20:30:55Z

I added a paragraph about the status command to the users-guide; rebased/squashed onto master again.

For the changelog entry i moved it to 1.25 for now; if you want to still merge this into 1.24 this needs to be changed again.

The testsuite for Cabal fails (locally) for some reason; but it does so on master in the same way, so I cannot test locally (https://gist.github.com/lspitzner/b9cb6a4831147767f24f). The AppVeyor failure seems to be unrelated to this commit as well (?)

lspitzner · 2016-02-23T20:34:10Z

Cabal/doc/installing-packages.markdown

+Configured compiler:
+  ghc-7.10.3
+~~~~~~~~~~~~~~~
+


See here for the only addition apart from rebasing since last update.

sebright · 2016-02-23T20:35:17Z

The AppVeyor failure is unrelated to the PR.

lspitzner · 2016-02-23T20:35:29Z

And sorry for the long wait.

hvr · 2016-02-24T10:21:33Z

@lspitzner btw, would an optional JSON representation make sense for cabal status?

lspitzner · 2016-02-24T13:05:41Z

@hvr I cannot currently see a use-case for JSON output. My intention for this command is to provide some feedback to the human user; for automated settings I would probably tend towards full clean; configure; build cycles, so querying the configuration state is unnecessary. I'd assign a higher priority to JSON representation for the build output, for example (- that does not exist yet, right?).

The "status" command prints a summary over several aspects of a cabal environment, such as the cabal and ghc versions, the package and its components, the package-databases, the sandbox etc.

# Conflicts: # Cabal/Distribution/Text.hs # Cabal/changelog # cabal-install/Distribution/Client/Freeze.hs # cabal-install/Distribution/Client/Setup.hs # cabal-install/Main.hs

lspitzner · 2016-03-31T12:35:56Z

Merged master again. Determining the currently configured compiler (version) seems to be broken now. Haven't investigated yet.

lspitzner · 2016-07-29T12:08:10Z

I have no interest in working on this PR any longer. Has apparently bitrotten by now, although most of the conflicts look like easy to fix.

I'll leave it to you to close this or leave it open; i don't know the policy for this.

23Skidoo · 2016-07-29T15:12:02Z

Closing in favour of #3643, which is an updated version of this PR.

23Skidoo · 2016-07-29T15:16:03Z

@lspitzner Thank you for working on this PR! I'll try to fix the remaining issues and get it merged.

lspitzner force-pushed the status branch 2 times, most recently from a0f5ece to 8e9c7fa Compare October 24, 2015 10:21

lspitzner force-pushed the status branch from 8e9c7fa to be3f443 Compare October 24, 2015 22:44

23Skidoo reviewed Nov 5, 2015
View reviewed changes

Cabal/Distribution/Text.hs Outdated

Copy link

Member

23Skidoo Nov 5, 2015

Choose a reason for hiding this comment

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

Why is this change needed?

23Skidoo reviewed Nov 5, 2015
View reviewed changes

Cabal/Distribution/Simple/Utils.hs Outdated

Copy link

Member

23Skidoo Nov 5, 2015

Choose a reason for hiding this comment

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

Please add a Haddock comment explaining what this function does.

23Skidoo reviewed Nov 5, 2015
View reviewed changes

cabal-install/Distribution/Client/Status.hs Outdated

Copy link

Member

23Skidoo Nov 5, 2015

Choose a reason for hiding this comment

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

Please change to "There is a different 'cabal' executable (version".

lspitzner force-pushed the status branch 2 times, most recently from a26a852 to d4d4dfa Compare November 15, 2015 19:28

23Skidoo added the cabal-install: other label Jan 16, 2016

23Skidoo added this to the cabal-install 1.24.1 milestone Feb 20, 2016

23Skidoo modified the milestones: cabal-install 1.24.1, cabal-install 1.24 Feb 23, 2016

lspitzner force-pushed the status branch from d4d4dfa to 497caee Compare February 23, 2016 20:04

lspitzner reviewed Feb 23, 2016
View reviewed changes

Add "status" command

4dd2e79

The "status" command prints a summary over several aspects of a cabal environment, such as the cabal and ghc versions, the package and its components, the package-databases, the sandbox etc.

lspitzner force-pushed the status branch from 497caee to 4dd2e79 Compare February 24, 2016 14:55

23Skidoo mentioned this pull request Mar 4, 2016

Fix space leak in solver backjumping #2916

Merged

23Skidoo modified the milestones: cabal-install 1.24, cabal-install 1.24.1 Mar 12, 2016

Merge remote-tracking branch 'official/master' into status

eec5753

# Conflicts: # Cabal/Distribution/Text.hs # Cabal/changelog # cabal-install/Distribution/Client/Freeze.hs # cabal-install/Distribution/Client/Setup.hs # cabal-install/Main.hs

23Skidoo added the type: enhancement label Apr 8, 2016

lspitzner mentioned this pull request Jul 29, 2016

"cabal paths" command #3616

Open

23Skidoo mentioned this pull request Jul 29, 2016

Add a 'status' command. #3643

Closed

23Skidoo closed this Jul 29, 2016

gbaz mentioned this pull request Aug 19, 2021

Add status command to cabal #7500

Closed

22 tasks

Comments

Conversation

lspitzner commented Oct 22, 2015

Uh oh!

lspitzner commented Oct 22, 2015

Uh oh!

dcoutts commented Oct 22, 2015

Uh oh!

23Skidoo commented Oct 22, 2015

Uh oh!

lspitzner commented Oct 22, 2015

Uh oh!

dcoutts commented Oct 22, 2015

Uh oh!

23Skidoo commented Oct 23, 2015

Uh oh!

lspitzner commented Oct 24, 2015

Uh oh!

23Skidoo commented Oct 24, 2015

Uh oh!

lspitzner commented Oct 24, 2015

Uh oh!

lspitzner commented Oct 25, 2015

Uh oh!

lspitzner commented Nov 5, 2015

Uh oh!

23Skidoo Nov 5, 2015

Choose a reason for hiding this comment

Uh oh!

23Skidoo commented Nov 5, 2015

Uh oh!

23Skidoo Nov 5, 2015

Choose a reason for hiding this comment

Uh oh!

23Skidoo commented Nov 5, 2015

Uh oh!

23Skidoo Nov 5, 2015

Choose a reason for hiding this comment

Uh oh!

BardurArantsson commented Nov 14, 2015

Uh oh!

23Skidoo commented Nov 14, 2015

Uh oh!

lspitzner commented Nov 15, 2015

Uh oh!

lspitzner commented Nov 15, 2015

Uh oh!

23Skidoo commented Dec 16, 2015

Uh oh!

lspitzner commented Feb 23, 2016

Uh oh!

lspitzner Feb 23, 2016

Choose a reason for hiding this comment

Uh oh!

sebright commented Feb 23, 2016

Uh oh!

lspitzner commented Feb 23, 2016

Uh oh!

hvr commented Feb 24, 2016

Uh oh!

lspitzner commented Feb 24, 2016

Uh oh!

lspitzner commented Mar 31, 2016

Uh oh!

lspitzner commented Jul 29, 2016

Uh oh!

23Skidoo commented Jul 29, 2016

Uh oh!

23Skidoo commented Jul 29, 2016

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants