more more files

This commit is contained in:
larshp 2017-05-18 17:16:15 +00:00
parent 04b81a17ff
commit cc5ab0c075
4 changed files with 164 additions and 8 deletions

View File

@ -27,14 +27,12 @@
- title: Reference
items:
- title: Global settings
- file: foo
title: foo
subitems:
- file: bar
title: bar
- file: moo
title: moo
- title: .abapgit.xml
file: ref-dot-abapgit
- title: Write protect
file: ref-write-protect
- title: Supported object types
file: ref-supported
- title: Other
items:

63
docs/ref-dot-abapgit.md Normal file
View File

@ -0,0 +1,63 @@
---
title: .abapgit.xml
---
**.abapgit.xml** is a special abapGit file. It contains meta information of the abapGit project.
Example: abapGit own .abapgit.xml
```xml
<?xml version="1.0" encoding="utf-8"?>
<asx:abap xmlns:asx="http://www.sap.com/abapxml" version="1.0">
<asx:values>
<DATA>
<MASTER_LANGUAGE>E</MASTER_LANGUAGE>
<STARTING_FOLDER>/src/</STARTING_FOLDER>
<FOLDER_LOGIC>PREFIX</FOLDER_LOGIC>
<IGNORE>
<item>/.travis.yml</item>
<item>/CONTRIBUTING.md</item>
<item>/LICENSE</item>
<item>/README.md</item>
<item>/package.json</item>
<item>/changelog.txt</item>
</IGNORE>
</DATA>
</asx:values>
</asx:abap>
```
# Description
## Master Language
The language in which all documentation and dictionary elements texts will be created. Follows SAP `sy-langu` values.
## Starting Folder
The Git repository folder that defines the root folder where deserialization starts.
## Folder Logic
abapGit follows two folder logics: PREFIX and FULL
### PREFIX
A package name must contain its parent package name as a prefix. Examples:
Valid prefix:
* ZFOO
* **ZFOO**_BAR
* **ZFOO_BAR**_QUX
Invalid prefix:
* ZFOO
* ZBAR
### FULL
Any package name is accepted
## Ignore
Files which abapGit will not download into your ABAP system.

78
docs/ref-supported.md Normal file
View File

@ -0,0 +1,78 @@
---
title: Supported object types
---
Type | Description | Supported
:------------ | :------------ | ------------:
ACID | Checkpoint Group | Yes
AUTH | Authorization Check Fields | Yes
BOBF | BOPF: Business Object Model | [Plugin](https://github.com/larshp/abapGit-Plugins)
CLAS | Class (ABAP Objects) | Yes
CMOD | Customer enhancement projects | [#151](https://github.com/larshp/abapGit/issues/151)
DCLS | ABAP Data Control Language Sources | Yes
DDLS | Data Definition Language Source | Yes
DOCT | General Text | Yes
DOCV | Documentation (Independent) | Yes
DOMA | Domain | Yes
DTEL | Data Element | Yes
ECAT | eCATT Test Script | [#163](https://github.com/larshp/abapGit/issues/163)
ECTD | eCATT Test Data Container | [#105](https://github.com/larshp/abapGit/issues/105)
ENHC | Composite Enhancement Implementation | Yes
ENHO | Enhancement Implementation | Partial [#113](https://github.com/larshp/abapGit/issues/113)
ENHS | Enhancement Spot | Yes
ENQU | Lock Object | Yes
FORM | SAPscript form | [#39](https://github.com/larshp/abapGit/issues/39)
FUGR | Function Group | Yes
IAMU | Language-Independent IAC Binary Data | [#81](https://github.com/larshp/abapGit/issues/81)
IARP | Parameters of IAC Language Resource | Yes
IASP | Parameters of an IAC service | Yes
IATU | Language-Independent IAC Templates | Yes
IWPR | Gateway Business Suite Enablement - Service Builder Project | [#75](https://github.com/larshp/abapGit/issues/75)
LPDC | Launchpad short texts | [#107](https://github.com/larshp/abapGit/issues/107)
MSAG | Message Class | Yes
NROB | Number Range Objects | Yes
PARA | SPA/GPA Parameters | Yes
PDTS | Standard Task | [#153](https://github.com/larshp/abapGit/issues/153)
PDWS | Workflow templates | [#154](https://github.com/larshp/abapGit/issues/154)
PINF | Package interface | Yes
PROG | Program | Yes
SAMC | ABAP Messaging Channels | Yes
SAPC | ABAP Push Channels | Yes
SFBF | Business Function + Assignment | Yes
SFBS | Business Function Set + Assignment | Yes
SFSW | Switch + Assignment of Objects to the Switch | Yes
SHI3 | General structure storage: Definition of a structure | Yes
SHLP | Search Help | Yes
SICF | ICF Service | Yes
SPLO | Format Types | Yes
SRFC | RFC Service | [#155](https://github.com/larshp/abapGit/issues/155)
SSFO | SAP Smart Form | Yes
SSST | SAP Smart Style | Yes
SFPI | Form Object: Interface | Yes
SFPF | Form Object: Form | Yes
SHMA | Shared Objects: Defined Area Attributes | [#85](https://github.com/larshp/abapGit/issues/85)
SMIM | Info Object from the MIME Repository | Yes
SPRX | Proxy Object | [#87](https://github.com/larshp/abapGit/issues/87)
STYL | SAPscript style | Yes
SUSC | Authorization object class | Yes
SUSO | Authorization object | Yes
SXCI | Business Add-Ins - Implementations | [#156](https://github.com/larshp/abapGit/issues/156)
TABL | Table | Yes
TOBJ | Definition of a Maintenance and Transport Object | Yes
TRAN | Transaction | Yes
TTYP | Table Type | Yes
TYPE | Type Group | Yes
VCLS | View cluster | Yes
VIEW | View | Yes
W3HT | Web Reporting/Internet Transaction Server HTML Templates | Yes
W3MI | Web Reporting/Internet Transaction Server MIME Types(binary | Yes
WAPA | BSP (Business Server Pages) Application | Yes
WDCA | Web Dynpro Application Configuration | [#79](https://github.com/larshp/abapGit/issues/79)
WDCC | Web Dynpro Component Configuration | [#78](https://github.com/larshp/abapGit/issues/78)
WDYA | Web Dynpro Application | Yes
WDYN | Web Dynpro Component | Yes
WEBI | Virtual End Point | Yes
XSLT | Transformation | Yes
Also see https://github.com/larshp/abapGit-Plugins

17
docs/ref-write-protect.md Normal file
View File

@ -0,0 +1,17 @@
---
title: Write protect
---
The write protected repository feature will make sure users cannot overwrite objects in the SAP system with objects from the git repository. So it helps enforcing that data can only go from the SAP system to the Git repository.
The feature disables pulls, uninstall of all objects, switching branches etc.
To enable:
1. from the abapGit main screen: Advanced -> Database util
2. find the repository, click "Edit"
3. find the value `<WRITE_PROTECT/>` and replace with `<WRITE_PROTECT>X</WRITE_PROTECT>`
4. restart abapGit(just to make sure caches are cleared)