ogma icon indicating copy to clipboard operation
ogma copied to clipboard

Cabal packages do not include repo information

Open ivanperez-keera opened this issue 9 months ago • 0 comments

Description

The cabal packages do not contain pointers to the repo using the specific entry for this in Cabal, neither for the source, nor to file bug reports. Although such information is not strictly speaking necessary, it helps direct users without having to "jump around" to find out where they need to go.

Type

  • Bug: Cabal files are missing useful information.

Additional context

None.

Requester

  • Ivan Perez

Method to check presence of bug

The following script checks whether cabal files contain bug-reports or repo information:

$ grep -Lre '\(bug-reports\|source-repository\)' --include='*.cabal' ogma**/
ogma-cli/ogma-cli.cabal
ogma-core/ogma-core.cabal
ogma-extra/ogma-extra.cabal
ogma-language-c/ogma-language-c.cabal
ogma-language-cocospec/ogma-language-cocospec.cabal
ogma-language-copilot/ogma-language-copilot.cabal
ogma-language-jsonspec/ogma-language-jsonspec.cabal
ogma-language-smv/ogma-language-smv.cabal
ogma-spec/ogma-spec.cabal

The output should be empty, meaning that all files contain such strings.

Expected result

Running the above grep command prints nothing, indicating that no cabal page is missing bug report or repo source information.

Desired result

Running the above grep command prints nothing, indicating that no cabal page is missing bug report or repo source information.

Proposed solution

Add bug-reports and source-repository entries to all cabal files.

Further notes

None.

ivanperez-keera avatar May 23 '24 01:05 ivanperez-keera