Skip to content

Commit 0e24b2f

Browse files
committed
Document Git cat. errors
1 parent fab455d commit 0e24b2f

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

docs/learn/errors.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,30 @@ Happens whenever we ask for a DIRECTORY yet you give us a path that points to a
5555

5656
Usually happens with kickstart. You provided a path that is _not_ empty, but _has to_ be empty. Thus, we demand emptying of the directory.
5757

58+
## Git category [Git]
59+
60+
Errors related to Git operations.
61+
62+
### No branch
63+
64+
> `Git__NoBranch`
65+
66+
Happens when the user specifies a branch that does indeed not exist.
67+
68+
### No branch at all
69+
70+
> `Git__NoBranchAA`
71+
72+
Happens when there's no branches at all. Git repos are supposed to always have a branch, so it is very unlikely - and if it happens it's most likely a bug.
73+
74+
### Unknown Errors
75+
76+
All errors in this category are `Git__UE__[ACTION]`, which can be `IsRepo`, `Push`, or `Commit`. Any unexpected error when performing any of these actions for any project will trigger a Task category `FknError`.
77+
78+
If unclear, `Git__UE__IsRepo` fires if an error happens trying to determine if a directory is a Git repo.
79+
80+
A completely unknown error will fire `Git__UE` with no specified action.
81+
5882
## Environment category [Env]
5983

6084
Errors related to environments; not in the sense of env variables, but in the sense of "project environments". That's how we refer to the structure we make of each of your projects in order to work with it.

0 commit comments

Comments
 (0)