facebook/sapling
1
1
Fork 0
mirror of https://github.com/facebook/sapling.git synced 2024-10-07 07:17:55 +03:00
Code Issues Projects Releases Wiki Activity
94690aa36d
sapling/eden/docs/Globbing.md
Matt Glazar 388cd7455a Document how globs work 
Summary:
I was thinking about teaching EdenFS' `globFiles` to follow symlinks. To help me think, I documented my understanding of how EdenFS currently handles glob patterns. Publish my notes, even if I decide to not change `globFiles`' behavior.

This document isn't meant to be thorough, so many definitions and nuances are omitted.

Reviewed By: simpkins

Differential Revision: D14288417

fbshipit-source-id: e78749e114224926c2673868854d068672e38cef
2019-03-07 14:20:57 -08:00

1.6 KiB
Raw Blame History

EdenFS file globs

EdenFS supports glob patterns through the following interfaces:

  • Ignore files (e.g. .gitignore)
  • globFiles Thrift API

Ignore files

EdenFS uses ignore files to exclude files in the getScmStatus Thrift API (used by hg status, for example). The syntax for EdenFS' ignore files is compatible with the syntax for gitignore files used by the Git version control system, even when an EdenFS checkout is backed by a Mercurial repository.

Glob pattern magic

EdenFS interprets the following tokens specially within glob patterns:

  • **: Match zero, one, or more path components.
  • *: Match zero, one, or more valid path component characters.
  • ?: Match exactly one valid path component characters.
  • [: Match exactly one path component character in the given set of characters. The set is terminated by ].
  • [!, [^: Match exactly one path component character not in the given set of characters. The set is terminated by ].

EdenFS glob patterns are compatible with gitignore patterns used by the Git version control system, even when an EdenFS checkout is backed by a Mercurial repository.

Globbing with symlinks

If a glob pattern matches a symlink exactly, globFile returns the symlink itself (and not its target) as a match.

If a prefix of a glob pattern matches a symlink, globFile does not return the symlink as a match, does not return the symlink's target as a match, and does not resolve the symlink in order to continue matching the glob pattern.