It gets pretty subtle. The ".git" directories aren't included in module
zips by the go command (I don't know if this is documented anywhere, but
it's very sensible behavior), but they aren't disallowed. A custom module
zip may include a ".foo", "_foo", or even ".git" directory with files.
In the the phrase you mentioned:
> Patterns must not match files outside the package's module, such as
‘.git/*’ or symbolic links
Symbolic links are neither included not allowed.
.git/* files aren't included by the go tool.
As I understand, the "such as ‘.git/*’ or symbolic links" part is just an
example of some common types of files that aren't included in modules. The
important part of that phrase is "Patterns must not match files outside the
package's module". For example, if you have this tree:
$ tree .
.
├── LICENSE
├── go.mod // module example.com/m1
├── p.go
├── p_test.go
└── nested
├── go.mod // example.com/m1/nested
├── foo.txt
└── ...
Then p.go can't embed "nested/foo.txt", because nested/foo.txt is going to
be outside of the m1 module.
If you're looking to improve package embed documentation, I suggest filing
an issue <https://golang.org/issue/new>. If your goal to understand this
better for your own interests, I hope you find the nuanced details above
interesting. :)
On Saturday, January 16, 2021 at 3:23:32 PM UTC-5 manlio....@gmail.com
wrote:
> https://golang.org/ref/mod#zip-path-size-constraints prevents directories
> that begin with a dot, but only because the directory is interpreted as a
> package.
> It is not clear, to me, if `.git` is ignored by the `embed` directive
> because it is the private directory of the VCS or because it starts with a
> dot.
>
>
> Thanks
> Manlio Perillo
> Il giorno sabato 16 gennaio 2021 alle 21:09:08 UTC+1
> axel.wa...@googlemail.com ha scritto:
>
>> I think this is the best doc about what is included in a module:
>> https://golang.org/ref/mod#zip-path-size-constraints
>> Everything not in that list is "outside" that module.
>>
>> On Sat, Jan 16, 2021 at 9:02 PM Manlio Perillo <manlio....@gmail.com>
>> wrote:
>>
>>> Thanks. I was only considering the parent of the module's root
>>> directory.
>>> Is the concept of "outside the module" defined somewhere?
>>>
>>> Manlio Perillo
>>>
>>> Il giorno sabato 16 gennaio 2021 alle 19:30:05 UTC+1
>>> axel.wa...@googlemail.com ha scritto:
>>>
>>>> To put it another way:
>>>>
>>>> The second phrase is a lexical requirement about the pattern. It must
>>>> not contain a . or .. element - whether or not the result is included in
>>>> the module (e.g. "foo/../foo/bar" is not allowed either, even though it's
>>>> equivalent to "foo/bar").
>>>>
>>>> But, a lexical path *in* the module might still refer to a file not
>>>> included in it it - either by a symlink, or by being in the .git directory
>>>> (and maybe other cases I'm unaware of). So, the first phrase excludes any
>>>> case where the file is not included the module, whether or not the name
>>>> you
>>>> refer it by lexically contains . or '..'.
>>>>
>>>> Both phrases are necessary.
>>>>
>>>> On Sat, Jan 16, 2021 at 7:24 PM Axel Wagner <axel.wa...@googlemail.com>
>>>> wrote:
>>>>
>>>>> I don't think they do. There are two examples in the first phrase,
>>>>> which are not excluded by the second - the ".git" directory and a
>>>>> symbolic
>>>>> link (pointing outside of the module).
>>>>>
>>>>> On Sat, Jan 16, 2021 at 7:11 PM Manlio Perillo <manlio....@gmail.com>
>>>>> wrote:
>>>>>
>>>>>> I'm reading the https://tip.golang.org/pkg/embed/ package
>>>>>> documentation and I found a possible inconsistency.
>>>>>>
>>>>>> At the end of https://tip.golang.org/pkg/embed/#hdr-Directives:
>>>>>> "Patterns must not match files outside the package's module, such as
>>>>>> ‘.git/*’ or symbolic links"
>>>>>> and
>>>>>> "Patterns must not contain ‘.’ or ‘..’ path elements nor begin with a
>>>>>> leading slash"
>>>>>>
>>>>>> It seems to me that the first phrase is not necessary, since the
>>>>>> second phrase prevents matching files outside the package module.
>>>>>>
>>>>>>
>>>>>> Thanks
>>>>>> Manlio Perillo
>>>>>>
>>>>>> --
>>>>>> You received this message because you are subscribed to the Google
>>>>>> Groups "golang-nuts" group.
>>>>>> To unsubscribe from this group and stop receiving emails from it,
>>>>>> send an email to golang-nuts...@googlegroups.com.
>>>>>> To view this discussion on the web visit
>>>>>> https://groups.google.com/d/msgid/golang-nuts/5e1d688e-cdb4-4b32-a06a-086a6b097064n%40googlegroups.com
>>>>>>
>>>>>> <https://groups.google.com/d/msgid/golang-nuts/5e1d688e-cdb4-4b32-a06a-086a6b097064n%40googlegroups.com?utm_medium=email&utm_source=footer>
>>>>>> .
>>>>>>
>>>>> --
>>> You received this message because you are subscribed to the Google
>>> Groups "golang-nuts" group.
>>> To unsubscribe from this group and stop receiving emails from it, send
>>> an email to golang-nuts...@googlegroups.com.
>>>
>> To view this discussion on the web visit
>>> https://groups.google.com/d/msgid/golang-nuts/37f4c78b-ee26-45d1-8f61-f45e2acd978dn%40googlegroups.com
>>>
>>> <https://groups.google.com/d/msgid/golang-nuts/37f4c78b-ee26-45d1-8f61-f45e2acd978dn%40googlegroups.com?utm_medium=email&utm_source=footer>
>>> .
>>>
>>
--
You received this message because you are subscribed to the Google Groups
"golang-nuts" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to golang-nuts+unsubscr...@googlegroups.com.
To view this discussion on the web visit
https://groups.google.com/d/msgid/golang-nuts/b1cbe715-78ca-462b-acf9-7796c589de31n%40googlegroups.com.
