diff --git a/docs/_config.yml b/docs/_config.yml index 3ccefe62f..45945b9da 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,5 +1,6 @@ title: abapGit Docs keep_files: [explore.html, repos.json] +highlighter: rouge defaults: - scope: diff --git a/docs/_data/navigation.yml b/docs/_data/navigation.yml index e69709b4c..9b9034f56 100644 --- a/docs/_data/navigation.yml +++ b/docs/_data/navigation.yml @@ -39,11 +39,11 @@ - title: Other items: - title: Articles and Presentations - file: other-articles - - file: ZABAPGIT_TEST_SSL - title: ZABAPGIT_TEST_SSL + file: other-articles-and-presentations + - title: ZABAPGIT_TEST_SSL + file: other-test-ssl - title: XML mismatch - file: xml-mismatch + file: other-xml-mismatch - title: Object File Formats file: other-file-formats - title: Technical Links diff --git a/docs/other-articles-and-presentations.md b/docs/other-articles-and-presentations.md new file mode 100644 index 000000000..758121400 --- /dev/null +++ b/docs/other-articles-and-presentations.md @@ -0,0 +1,42 @@ +--- +title: Articles and Presentations +--- + +### 2014 + +[Git client for ABAP – alpha release](http://blogs.sap.com/2014/07/17/git-client-for-abap-alpha-release/) +-Lars Hvam + +### 2016 + +[How can I use Git and GitHub for SAP software development?](http://searchsap.techtarget.com/answer/How-can-I-use-Git-and-GitHub-for-SAP-software-development) +-Ethan Jewett + +[Implementing modern practices in an ABAP development shop](http://searchsap.techtarget.com/tip/Implementing-modern-practices-in-an-ABAP-development-shop) +-Ethan Jewett + +[SAP Inside Track Hamburg](https://larshp.github.io/sithh2016/) +-Lars Hvam + +[SAP Teched Barcelona](https://larshp.github.io/teched-2016-emea/) +-Lars Hvam + +### 2017 + +[SAP d-kom Karlsruhe](https://larshp.github.io/dkom2017/) +-Lars Hvam + +[First look at ABAPGit & ideas on a feature](https://themanmountain.github.io/2017/04/19/first_look_at_abapgit.html) +-Alex Cook + +[SAP Inside Track Ballerup](https://larshp.github.io/sitbal2017/), May 6th +-Lars Hvam + +[ABAP – Using git for safety and transparency](https://blogs.sap.com/2017/05/07/abap-using-git-for-safety-and-transparency/) +-Lars Hvam + +Mastering SAP Technologies, Melbourne, May 23rd +-Graham Robinson + +SAP Teched Las Vegas +-Graham Robinson \ No newline at end of file diff --git a/docs/other-file-formats.md b/docs/other-file-formats.md new file mode 100644 index 000000000..7b572bc70 --- /dev/null +++ b/docs/other-file-formats.md @@ -0,0 +1,22 @@ +--- +title: Object File Formats +--- + +# CLAS +One ABAP file, corresponding to the editable parts in source based class builder or ABAP in Eclipse: + +* `zcl_example.clas.abap` +* `zcl_example.clas.locals_def.abap` +* `zcl_example.clas.locals_imp.abap` +* `zcl_example.clas.testclasses.abap` +* `zcl_example.clas.macros.abap` + +Files does not exist if empty + +One XML file `zcl_example.clas.xml` containing: + +* VSEOCLASS information +* TPOOL information +* SOTR information +* LINES from DOKU +* Descriptions from SEOCOMPOTX \ No newline at end of file diff --git a/docs/other-technical-links.md b/docs/other-technical-links.md new file mode 100644 index 000000000..9848e2187 --- /dev/null +++ b/docs/other-technical-links.md @@ -0,0 +1,36 @@ +--- +title: Technical Links +--- + +Collection of links to various git related documentation, + +https://gist.github.com/schacon/6092633 + +https://github.com/git/git/blob/master/Documentation/technical/pack-protocol.txt + +https://github.com/git/git/blob/master/Documentation/technical/http-protocol.txt + +https://github.com/git/git/blob/master/Documentation/technical/protocol-capabilities.txt + +https://github.com/git/git/blob/master/Documentation/technical/pack-format.txt + +https://github.com/git/git/tree/master/Documentation/technical + +http://schacon.github.io/gitbook/7_the_packfile.html + +http://alblue.bandlem.com/2011/08/git-tip-of-week-objects.html + +https://git-scm.herokuapp.com/book/en/Git-Internals-Transfer-Protocols + +https://github.com/git/git/blob/master/builtin/receive-pack.c + +http://stefan.saasen.me/articles/git-clone-in-haskell-from-the-bottom-up/ + +```bash +set GIT_CURL_VERBOSE=1 +$env:GIT_CURL_VERBOSE=1 +$env:GIT_TRACE=1 +git config --global http.proxy %HTTP_PROXY% +git config --global --unset http.proxy +git config --global http.sslVerify false +``` diff --git a/docs/other-test-ssl.md b/docs/other-test-ssl.md new file mode 100644 index 000000000..15089a99a --- /dev/null +++ b/docs/other-test-ssl.md @@ -0,0 +1,70 @@ +--- +title: ZABAPGIT_TEST_SSL +--- + +Following report can be used to test SSL connection to github, + +```abap +REPORT zabapgit_test_ssl. + +* See https://github.com/larshp/abapGit/ + +PARAMETERS: p_url TYPE swc_value DEFAULT 'https://github.com', + p_proxy TYPE string, + p_pxport TYPE string. + +START-OF-SELECTION. + PERFORM run. + +FORM run. + + DATA: lv_code TYPE i, + lv_url TYPE string, + li_client TYPE REF TO if_http_client, + lv_error_message TYPE string. + + lv_url = p_url. + cl_http_client=>create_by_url( + EXPORTING + url = lv_url + ssl_id = 'ANONYM' + proxy_host = p_proxy + proxy_service = p_pxport + IMPORTING + client = li_client ). + +* enter username and password for proxy authentication if needed +* li_client->authenticate( +* proxy_authentication = abap_true +* username = '' +* password = '' ). + + li_client->send( ). + li_client->receive( + EXCEPTIONS + http_communication_failure = 1 + http_invalid_state = 2 + http_processing_failed = 3 + OTHERS = 4 ). + IF sy-subrc <> 0. + WRITE: / 'Error Number', sy-subrc. + MESSAGE ID sy-msgid TYPE sy-msgty NUMBER sy-msgno WITH sy-msgv1 sy-msgv2 sy-msgv3 sy-msgv4. + li_client->get_last_error( + IMPORTING + message = lv_error_message ). + WRITE: / `Error message: ` && lv_error_message. + WRITE: / 'Also check transaction SMICM -> Goto -> Trace File -> Display End'. + RETURN. + ENDIF. + + li_client->response->get_status( + IMPORTING + code = lv_code ). + IF lv_code = 200. + WRITE: / 'Success, it works'. + ELSE. + WRITE: / 'Error', lv_code. + ENDIF. + +ENDFORM. +``` \ No newline at end of file diff --git a/docs/other-xml-mismatch.md b/docs/other-xml-mismatch.md new file mode 100644 index 000000000..01c8794a4 --- /dev/null +++ b/docs/other-xml-mismatch.md @@ -0,0 +1,30 @@ +--- +title: XML Mismatch +--- + +### For end-users +Make sure you have the latest version of abapGit installed, see https://github.com/larshp/abapGit/wiki/Updating-abapGit, after updating try again. + +If the error persists, submit an issue to the maintainer of the repository requesting to update to latest version of abapGit serialized files pointing to the guide below. + +Or alternatively install an old version of abapGit to allow for installing the files, see next section "For maintainers" + +### For maintainers +If the latest version of abapGit is installed and the erorr message is shown, then the serialized files should be updated to the latest version. + +The steps are: + +1. Install old abapGit version, matching the serialized files + +2. Install objects into the ABAP system + +3. Install newest abapGit version + +4. Use the new abapGit to save the files to the git repository + +This will overwrite the files in the repository to have the latest format, compatible with the newest abapGit release. + +| abapGit | Download | XML Serialization | +| :------------- |:------------- |:-------------| +| v1.0.0 to current | [Link](https://raw.githubusercontent.com/larshp/abapGit/build/zabapgit.txt) | v1.0.0 | +| v0.0.0 to v0.113.0 | [Link](https://raw.githubusercontent.com/larshp/abapGit/v0.113.0/zabapgit.prog.abap) | v0.2-alpha | \ No newline at end of file