Skip to content

Commit c5216df

Browse files
authored
Update Repo Settings (#183)
1 parent 6a5c02a commit c5216df

File tree

7 files changed

+43
-15
lines changed

7 files changed

+43
-15
lines changed
Loading
Loading
Loading

src/user-guide/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@ index: false
6565
- [Namespaces](reference/namespaces.md)
6666
- [Packages & Transports](reference/packages.md)
6767
- [Folders & Files](reference/folders-filenames.md)
68+
- [Note Analyzer](note-analyzer.md)
6869
- [APACK](reference/apack.md)
6970
- [Database Utility](reference/database-util.md)
7071

src/user-guide/reference/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,5 +18,6 @@ dir:
1818
- [Namespaces](namespaces.md)
1919
- [Packages & Transports](packages.md)
2020
- [Folders & Files](folders-filenames.md)
21+
- [Note Analyzer](note-analyzer.md)
2122
- [APACK](apack.md)
2223
- [Database Utility](database-util.md)

src/user-guide/reference/note-analyzer.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
---
22
title: Note Analyzer
33
category: reference
4-
order: 79
4+
order: 85
55
---
66

77
## Note Analyzer for abapGit
88

9-
Note Analyzer is a program included in transaction SNOTE. For more information, see SAP Note [3200109](https://me.sap.com/notes/3200109), which includes the documentation of the program an attachment.
9+
Note Analyzer is a program included in transaction SNOTE. For more information, see SAP Note [3200109](https://me.sap.com/notes/3200109), which includes the documentation of the program as an attachment.
1010

1111
### Usage
1212

13-
The [Note_Analyzer_for_abapGit.xml](/assets/note-analyzer/Note_Analyzer_for_abapGit.xml) file includes all SAP Notes recommended for abapGit. It can be used to check if any of these SAP Notes are relevant for your system.
13+
The [Note_Analyzer_for_abapGit.xml](/assets/note-analyzer/Note_Analyzer_for_abapGit.xml) file includes all SAP Notes recommended for abapGit. It can be used to check if any of these SAP Notes are relevant to your system.
1414

1515
![](/img/note_analyzer_1.png)
1616

src/user-guide/repo-settings/dot-abapgit.md

Lines changed: 38 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ category: repo settings
44
order: 10
55
---
66

7-
**`.abapgit.xml`** is a special abapGit file. It contains meta information of the abapGit project. The file must be located in the root folder of the git repository.
7+
**`.abapgit.xml`** is a special abapGit file. It contains meta information on the abapGit project. The file must be located in the root folder of the Git repository.
88

99
It is recommended to edit .abapgit.xml using "Repository Settings" ![](/img/repo_settings.png) in abapGit.
1010
(In exceptional cases, you could edit the XML directly via "Utilities > Database Util" ![](/img/utilities.png).)
@@ -31,12 +31,26 @@ Example: abapGit's own `.abapgit.xml`
3131
The following settings are stored in the repository and therefore valid for all users.
3232

3333
![](/img/repo_settings_abapgit_xml.png)
34+
![](/img/repo_settings_abapgit_xml_2.png)
35+
![](/img/repo_settings_abapgit_xml_3.png)
36+
37+
## Name and Version
38+
39+
You can give your repository a name and version. The name will be used in the corresponding column of the repository list. The version is taken from the code by specifying a constant in a class or interface that's part of your project.
40+
41+
:::info
42+
Users can overwrite the official name by entering a display name in their local settings.
43+
:::
44+
45+
## Texts
3446

3547
### Main Language
3648

37-
The main language is the languages in which all texts belonging to repository objects will be created. It follows the SAP `sy-langu` values. Note that this implies that all objects in a repository must have the same main language.
49+
The main language is the language in which all texts belonging to repository objects will be created. It follows the SAP `sy-langu` values. Note that this implies that all objects in a repository must have the same main language.
3850

39-
**Note:** abapGit does *not* support changing the main language of objects. Therefore, this setting can not be changed using abapGit. If the main language was changed in the git repository, you will have to uninstall the repository your system (in the current main language) and reinstall it (in the new main language).
51+
:::warning
52+
abapGit does *not* support changing the main language of objects. Therefore, this setting can not be changed using abapGit. If the main language was changed in the git repository, you will have to uninstall the repository in your system (in the current main language) and reinstall it (in the new main language).
53+
:::
4054

4155
### Translation Languages
4256

@@ -47,11 +61,13 @@ There are currently two options available for including translations in a reposi
4761

4862
If no translation languages are maintained in this setting, the first approach is used. If you maintain a list of translation languages (comma-separated, 2-letter ISO language codes), then these languages will be included in the serialization. See also [Translations and i18n](/user-guide/reference/translations.md)
4963

50-
Note: You can suppress translations with the local "Only Serialize Main Language" setting (see below).
64+
You can suppress translations with the local "Only Serialize Main Language" setting (see below).
65+
66+
## Files
5167

5268
### Starting Folder
5369

54-
The Git repository folder that defines the root folder where deserialization starts.
70+
The starting folder is the Git repository folder that defines the root where deserialization starts.
5571

5672
### Folder Logic
5773

@@ -84,7 +100,7 @@ ZFOO
84100
ZBAR
85101
```
86102

87-
The folder logic PREFIX allows to install a repository into a different parent package (in different systems). This can even be local packages (`$*`), in which case no transport order is required.
103+
The folder logic PREFIX allows installing a repository into a different parent package (in different systems). This can even be local packages (`$*`), in which case no transport order is required.
88104

89105
#### Full
90106

@@ -104,11 +120,11 @@ This will produce the following folder structure:
104120
/src/zsomething/zhello
105121
```
106122

107-
The folder logic FULL forces the installation of a repository into packages with exactly the same name. Note that this can be problematic for contributors who use a system where specific prefixes for the package names are to be used.
123+
The folder logic FULL forces the installation of a repository into packages with the same name. Note that this can be problematic for contributors who use a system where specific prefixes for the package names are to be used.
108124

109125
#### Mixed
110126

111-
The folder logic MIXED combines PREFIX and FULL. The root package name will be used as prefix for all sub-packages but the package names are not concatenated recursively. This will allow to use significantly logic package names.
127+
The folder logic MIXED combines PREFIX and FULL. The root package name will be used as a prefix for all sub-packages but the package names are not concatenated recursively. This will allow to use significantly logic package names.
112128

113129
Example package hierarchy:
114130

@@ -130,15 +146,25 @@ This will produce the following folder structure:
130146

131147
### Ignore Files
132148

133-
Files which abapGit will not download to your ABAP system. Typically, this includes references to readme, changelog, and license
149+
Files that abapGit will not download to your ABAP system. Typically, this includes references to readme, changelog, and license
134150
files as well as repository configuration related to workflows like build or linting jobs.
135151

136-
Assuming that default starting folder /src/ is used, any files in root / or any other folder than the starting folder are ignored automatically. Therefore it will not be necessary to list files of the root folder into the ignore list (and as a consequence, the default ignore list is empty).
152+
Assuming that the default starting folder `/src/` is used, any files in root `/` or any other folder than the starting folder are ignored automatically. Therefore it will not be necessary to list files of the root folder in the ignore list (and as a consequence, the default ignore list is empty).
137153

138-
The ignore logic is based on "covers pattern" operator (not regex). A file is ignored, if path & file covers at least one of the patterns listed in this setting.
154+
The ignore logic is based on the "covers pattern" operator (not regex). A file is ignored, if the path and file cover at least one of the patterns listed in this setting.
139155

140-
Example: `/src/hr/zcl_confidential*` will ignore all classes in the /src/hr package that begin with `zcl_confidential`.
156+
Example: `/src/hr/zcl_confidential*` will ignore all classes in the `/src/hr` package that begin with `zcl_confidential`.
157+
158+
## ABAP
141159

142160
### Requirements
143161

144162
In this section, you can specify the minimum requirements that should be fulfilled to allow installation of the repository. Listed software components should exist in the target system and be at the given release or higher. If the target system matches the minimum release, then it must also be at the given patch level or higher.
163+
164+
### ABAP Language Version
165+
166+
:::warning
167+
Using ABAP Language Version in abapGit is still an experimental feature.
168+
:::
169+
170+
You can define how abapGit handles the ABAP Language Version of objects in a repository. The default setting is "Any" which allows objects of any ABAP Language Version to be included in your repository. The other settings will limit the type of objects to exactly one of the ABAP Language Versions. For more details, see [ABAP Language Version](./reference/abap-language-version.html).

0 commit comments

Comments
 (0)