summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthew Leeds <matthew.leeds@endlessm.com>2019-07-21 19:51:42 -0700
committerAtomic Bot <atomic-devel@projectatomic.io>2019-08-15 09:07:14 +0000
commitf09049b7aa25af64e46ef67b30e950ee1cec4d01 (patch)
treeeae7e8fe0faa81596b5021b09d1874d106e117f3
parentf80cce6b8d6a397a232c3a88bf1411f7045cc5e4 (diff)
downloadflatpak-f09049b7aa25af64e46ef67b30e950ee1cec4d01.tar.gz
common: Fix branch validation docs
The docs for flatpak_is_valid_branch() say branch names can't start with a digit but the implementation doesn't enforce this, and we have lots of branches out in the wild that start with a digit (e.g. "3.32" and "5.12"). So make the docs imply that branches can start with a digit. The implementation also disallows "." as the leading character for a branch, so add that to the docs. I'm just guessing that "." was intended to be disallowed but it makes sense; otherwise the file we create named with the branch would be hidden. Closes: #3023 Approved by: alexlarsson
-rw-r--r--common/flatpak-utils.c2
1 files changed, 1 insertions, 1 deletions
diff --git a/common/flatpak-utils.c b/common/flatpak-utils.c
index d9912e85..bb34ba20 100644
--- a/common/flatpak-utils.c
+++ b/common/flatpak-utils.c
@@ -999,7 +999,7 @@ is_valid_branch_character (gint c)
*
* Branch names must only contain the ASCII characters
* "[A-Z][a-z][0-9]_-.".
- * Branch names may not begin with a digit.
+ * Branch names may not begin with a period.
* Branch names must contain at least one character.
*
* Returns: %TRUE if valid, %FALSE otherwise.