lint: Allow texinfo markup at beginning of synopsis.

* guix/lint.scm(check-synopsis-style)[check-proper-start]: Add condition.
* tests/lint.scm: Add test case.

Change-Id: I2509b3a4e7e51c6a274697ceb5f776c22e27c5f9
Signed-off-by: Ludovic Courtès <ludo@gnu.org>
This commit is contained in:
Gabriel Wicki 2024-12-02 23:37:40 +01:00 committed by Ludovic Courtès
parent f28c32089d
commit 687f4e22e6
No known key found for this signature in database
GPG key ID: 090B11993D9AEBB5
2 changed files with 8 additions and 1 deletions

View file

@ -743,7 +743,8 @@ (define (check-synopsis-length synopsis)
'()))
(define (check-proper-start synopsis)
(if (properly-starts-sentence? synopsis)
(if (or (properly-starts-sentence? synopsis)
(starts-with-texinfo-markup? synopsis))
'()
(list
(make-warning package

View file

@ -307,6 +307,12 @@ (define (warning-contains? str warnings)
(check-synopsis-style pkg)))
string<?))
(test-equal "synopsis: starts with texinfo markup"
'()
(let ((pkg (dummy-package "x"
(synopsis "@code{help}"))))
(check-synopsis-style pkg)))
(test-equal "synopsis: too long"
"synopsis should be less than 80 characters long"
(single-lint-warning-message