| 1 |
Hi, |
| 2 |
|
| 3 |
it would be nice to have parser friendly comments in package.mask |
| 4 |
|
| 5 |
The new format |
| 6 |
- must be as easy to read and write for humans as it is now. |
| 7 |
- must be structured |
| 8 |
|
| 9 |
|
| 10 |
|
| 11 |
Benefits of a parser friendly package.mask: |
| 12 |
|
| 13 |
- use it for statistics |
| 14 |
- list all packages which are overdue |
| 15 |
- pretty print a sorted list |
| 16 |
- use syntax highlighting and folding in editors |
| 17 |
- better pkgcheck/repoman checks for malformed masks |
| 18 |
- automatic nice and readable commit messages |
| 19 |
- get even more out of the mgorny-dev-scripts |
| 20 |
https://github.com/mgorny/mgorny-dev-scripts/blob/master/lr-add-pmask |
| 21 |
- all items have the same structure |
| 22 |
- # Removal after: 2021-09-01 is easier to read than |
| 23 |
# Masked for removal in 90 days. |
| 24 |
|
| 25 |
|
| 26 |
Example workflow on the command line |
| 27 |
|
| 28 |
$> lr-add-pmask app-misc/some-package 987654 2019-07-01 "Doesn't work |
| 29 |
with new libfoo. Upstream dead, gtk-1, smells all commented lines after |
| 30 |
Reason are the reason." |
| 31 |
|
| 32 |
$> lr-commit-pmask |
| 33 |
|
| 34 |
|
| 35 |
|
| 36 |
|
| 37 |
OLD FORMAT |
| 38 |
|
| 39 |
# Dev E. Loper <developer@g.o> (2019-07-01) |
| 40 |
# Masked for removal in 90 days. Doesn't work |
| 41 |
# with new libfoo. Upstream dead, gtk-1, smells |
| 42 |
# funny. (bug #987654). Others write Bug 123456. |
| 43 |
# Bug 1 is known well, but the second bug 2 hours to fix. |
| 44 |
app-misc/some-package |
| 45 |
|
| 46 |
|
| 47 |
Add your suggestions below for discussion: |
| 48 |
|
| 49 |
|
| 50 |
Suggestion 1) |
| 51 |
|
| 52 |
# Masked on: 2019-07-01 |
| 53 |
# Masked by: Dev E. Loper <developer@g.o> |
| 54 |
# Removal after: 2019-09-01 |
| 55 |
# Bugs: 123456, 123457 |
| 56 |
# Reason: Doesn't work with new libfoo. Upstream dead, gtk-1, smells |
| 57 |
# all commented lines after Reason are the reason. |
| 58 |
app-misc/some-package |
| 59 |
|
| 60 |
|
| 61 |
Suggestion 2) |
| 62 |
# MASKED ON: 2019-07-01 |
| 63 |
# MASKED BY: Dev E. Loper <developer@g.o> |
| 64 |
# REMOVAL AFTER: 2019-09-01 |
| 65 |
# BUGS: 123456 123457 |
| 66 |
# REASON: Doesn't work with new libfoo. Upstream dead, gtk-1, smells |
| 67 |
# all commented lines after Reason are the reason. Uppercase to |
| 68 |
# emphasize keywords. |
| 69 |
app-misc/some-package |
| 70 |
|
| 71 |
|
| 72 |
|
| 73 |
Suggestion 3) |
| 74 |
write your suggestion HERE |
| 75 |
|
| 76 |
How can we improve the format of package.mask for future scripts? |
| 77 |
Which suggestion is your preference? |
| 78 |
|
| 79 |
-- |
| 80 |
Best, |
| 81 |
Jonas |
Archives