bazelbuild / bazelbuild/rules_pkg

pkg_rpm documentation inconsistent with test example

Open
#410 1 comment 0 reactions 0 assignees View on GitHub
documentation P3
Dominant language
Starlark
Stars
253
Forks
221
Avg merge
10h 33m
Merged PRs (30d)
1

Description

The `pkg_rpm` invocation in https://github.com/bazelbuild/rules_pkg/blob/main/pkg/tests/rpm/BUILD shows a lot more options than the doc at https://github.com/bazelbuild/rules_pkg/blob/main/pkg/docs/reference.md#pkg_rpm. Which one is correct (probably neither :) )

Contributor guide

Open the contributing guide

Research direction

Compare the `pkg_rpm` invocation in `pkg/tests/rpm/BUILD` with the `pkg_rpm` reference in `pkg/docs/reference.md`. Determine which options and example are current, then make the documentation and test example consistent and verify the resulting example still matches the documented interface.

Written by the indexing model from the issue text.

Assessment

Domain
build-system, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.