Skip to content

Commit ecdb9d3

Browse files
committed
git-submodules: Clarify tagless submodules
1 parent 521e8c9 commit ecdb9d3

2 files changed

Lines changed: 16 additions & 0 deletions

File tree

20.7 KB
Loading

src/mini-tutors/git-submodules.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,12 @@ requirements](../packaging/j4-dmenu-desktop.md#quality-requirements) (but it
3030
depends), so packaging them as a dependency might not be reasonable. Leaving the
3131
header only dependency as a git submodule is preferable in this scenario.
3232

33+
```admonish info
34+
If the submodule doesn't have tags, it can't be packaged, because it doesn't
35+
meet quality requirements. If that is the case, it must be handled like a
36+
submodule using methods described below.
37+
```
38+
3339
### Release archives
3440
This tutorial assumes that the submodule isn't included in the release archive.
3541
GitHub doesn't include submodules in default release archives and upstream
@@ -117,6 +123,16 @@ tag. Tags should be preferred over commit hashes because they are nicer,
117123
shorter and more descriptive.
118124

119125
#### Finding out submodule's tag
126+
127+
```admonish info
128+
If the submodule has no tags (like in the picture below):
129+
130+
![no tags](../images/git_submodules/no_tags.png)
131+
132+
You can skip this step and go to [getting the archive](#getting-the-archive)
133+
while using the commit hash you got before.
134+
```
135+
120136
To find out whether a commit is tied to a tag, click on the top commit:
121137

122138
![tag commit](../images/git_submodules/tag_commit.png)

0 commit comments

Comments
 (0)