-
-
Notifications
You must be signed in to change notification settings - Fork 2
/
README_EN.txt
160 lines (122 loc) · 4.59 KB
/
README_EN.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
* README_EN.txt
* 2024.08.31
* gituserbin
1. DESCRIPTION
2. REPOSITORIES
3. PREREQUISITES
4. DEPENDENCIES
5. USAGE
6. PROJECT CONFIGURATION VARIABLES
7. AUTHOR
-------------------------------------------------------------------------------
1. DESCRIPTION
-------------------------------------------------------------------------------
Git user script wrappers for projects root directory.
-------------------------------------------------------------------------------
2. REPOSITORIES
-------------------------------------------------------------------------------
Primary:
* https://github.com/andry81/gituserbin/branches
https://github.com/andry81/gituserbin.git
First mirror:
* https://sf.net/p/gitcmd/gituserbin/ci/master/tree
https://git.code.sf.net/p/gitcmd/gituserbin
Second mirror:
* https://gitlab.com/andry81/gituserbin/-/branches
https://gitlab.com/andry81/gituserbin.git
Gitcmd:
Primary:
* https://github.com/andry81/gitcmd
First mirror:
* https://sf.net/p/gitcmd/gitcmd
Second mirror:
* https://gitlab.com/andry81/gitcmd
Contools:
Primary:
* https://github.com/andry81/contools
First mirror:
* https://sf.net/p/contools/contools
Second mirror:
* https://gitlab.com/andry81/contools
-------------------------------------------------------------------------------
3. PREREQUISITES
-------------------------------------------------------------------------------
Currently used these set of OS platforms, applications to run
with or from and repositories:
1. OS platforms:
* Windows 7+
2. Applications:
* msys2
https://www.msys2.org/#installation
- Freeware Unix-like environment for the Windows.
* cygwin
https://cygwin.com
- Freeware Unix-like environment for the Windows.
* Git 2.24+
https://git-scm.com
- Freeware console application to maintain GIT version control system.
3. Repositories:
* gitcmd
You must put the repository working copy into the
`$PROJECTS_ROOT/andry81/gitcmd/gitcmd` directory.
* contools
You must put the repository working copy into the
`$PROJECTS_ROOT/andry81/contools/contools` directory.
-------------------------------------------------------------------------------
4. DEPENDENCIES
-------------------------------------------------------------------------------
* gitcmd
* contools
-------------------------------------------------------------------------------
5. USAGE
-------------------------------------------------------------------------------
Put `gutuserbin` scripts into the root of your git repositories to call them
using the `..` syntax from the console windows opened in a repository working
copy:
<root>
|
+- <USER>
| |
| +- <REPO-GROUP>
| |
| +- <REPO>
| # Current directory of your opened console window.
|
... # gituserbin scripts ...
>
../../../<git-user-bin-script> ...
NOTE:
Each script basically is a wrapper to a script from the `gitcmd` project.
To read the usage description you must open the corresponding `gitcmd`
script.
-------------------------------------------------------------------------------
6. PROJECT CONFIGURATION VARIABLES
-------------------------------------------------------------------------------
To be able to use the scripts you have to declare the set of environment
variables. Here is described only a limited set of variables, you have to open
each corresponding script to find out which one variable you must to define.
* PROJECTS_ROOT
Main environment variable to call the `gitcmd` project scripts.
* GIT_REPO_DEFAULT_REMOTES
Variable for the `gitcmd/scripts/git_init.sh` (`gituserbin/git-init.sh`)
script to initialize multiple remotes by default.
* GIT_USER, GIT_USER_MAIL
Git user and email by default for the
`gitcmd/scripts/git_filter_branch_user.sh` (`gituserbin/fix-mail.sh`) script.
* GIT_SHELL_ROOT
Main environment variable to call bash shell scripts from Windows batch
scrtips (`*.bat`).
* GIT_AUTH_USER
Git user with authentication to use from `gituserbin/ssh-login-*.sh`
scripts.
* SSH_SHELL_ROOT
Main environment variable to call `ssh.exe` console utility from
`gituserbin/ssh-*.*` scripts.
* SSH_GIT_AUTH_USER
Git user with authentication to use in case of git+ssh authentication,
for example, in `gitcmd/scripts/git_init.sh`
(`gituserbin/git-init.sh`) script.
-------------------------------------------------------------------------------
7. AUTHOR
-------------------------------------------------------------------------------
Andrey Dibrov (andry at inbox dot ru)