Skip to content

Set the minimal requirement for Haddock and protobuf - #1108

Merged
mergify[bot] merged 2 commits into
masterfrom
repro_1030
Sep 30, 2019
Merged

Set the minimal requirement for Haddock and protobuf#1108
mergify[bot] merged 2 commits into
masterfrom
repro_1030

Conversation

@guibou

@guibou guibou commented Sep 22, 2019

Copy link
Copy Markdown
Contributor

This is a first step to fix #1030. It comes with tests:

  • //tests/haddock_protobuf:haddocks_b was failing, it is now fixed
  • //tests/haddock_protobuf:haddocks_a builds, but the haddock process
    does not see the documentation link for
    Proto.Tests.HaddockProtobuf.HelloWorld.Person. Not fixed yet.

@guibou
guibou force-pushed the repro_1030 branch 2 times, most recently from 5c41922 to 5445a22 Compare September 22, 2019 13:49
@guibou guibou changed the title Reproduction code for #1030 Set the minimal requirement for Haddock and protobuf Sep 22, 2019
@guibou
guibou marked this pull request as ready for review September 22, 2019 14:19

@mboes mboes left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I don't feel confident about this code change. @aherrmann I'm handing over the baton to you.

Comment thread haskell/protobuf.bzl
"HaskellLibraryInfo",
"HaskellProtobufInfo",
)
load(":private/pkg_id.bzl", "pkg_id")

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
load(":private/pkg_id.bzl", "pkg_id")

This looks unused.

Comment thread haskell/protobuf.bzl

haddock_info = HaddockInfo(
package_id = None,
package_id = package_id,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Is it necessary to duplicate package_id in HaddockInfo, or would the field in HaskellLibraryInfo suffice? In other words, do we have targets that provide HaddockInfo but not HaskellLibraryInfo?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I don't believe we need this duplication.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I do agree with you. However I thank that's orthogonal to this pull request.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Fair enough. That can also be done in a separate PR.

@aherrmann aherrmann added the merge-queue merge on green CI label Sep 30, 2019
- `//tests/haddock_protobuf:haddocks_b` fails
- `//tests/haddock_protobuf:haddocks_a` builds, but the haddock process
does not see the documentation link for
'Proto.Tests.HaddockProtobuf.HelloWorld.Person'
`package_id` cannot be None, because it is used in the rest of the
process. It is now set to the real name of this haskell package.

The protobuf process does not generate haddock informations, as reported
in #1030, leading to missing documentation link and build failures.

`transitive_html` must contain a key with the current package_id. This
is fixed to an empty list.

This is a partial fix for #1030 because it fixs the build failure
@mergify
mergify Bot merged commit fc9764f into master Sep 30, 2019
@mergify
mergify Bot deleted the repro_1030 branch September 30, 2019 09:20
@mergify mergify Bot removed the merge-queue merge on green CI label Sep 30, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

haskell_doc should support haskell_proto_library

3 participants