[Doc] Updates for local copybook support #383

zeibura · 2020-06-08T13:32:36Z

Readme updates

local copybook support information added
note added about specifying copybook names in upper case only
clarified the functionality of "go to definition" with copybooks
expanded the intro to copybook support section

zeibura · 2020-06-08T14:37:39Z

I've added a new GIF too showing Go To Definition in a copybook.

zimlu02 · 2020-06-08T16:10:56Z

README.md


-#### Retrieving Copybooks
+Ensure that copybook names are specified in your source code in upper case, for example `COPY BOOK1` and not `COPY book1`.


Lower case copybooks' names won't be resolved and stay marked as an error.

done in latest commit

zimlu02 · 2020-06-08T16:12:17Z

README.md

 4. Under **Profile**, enter the name of your Zowe CLI z/OSMF profile.
 5. Open a program or project.  
-   All copybooks used in the program or project which are not stored locally are downloaded from the mainframe data sets that you specified in step 3. Copybooks are stored locally in a **.copybooks** directory within the workspace, which is created automatically.
+   All copybooks used in the program or project which are not stored locally are downloaded from the mainframe data sets that you specified in step 3. Copybooks are stored locally in a **.copybooks** directory within the workspace, which is created automatically.  


do we want to be more specific here? It gets saved under:
.c4z/.copybooks/<profile>/<DSN>/

has this been changed? the workspace I created in 0.11.1 has the mainframe copybooks saved in /.copybooks which isn't a subfolder of /.c4z.

you need the "next" version...sent on slack

Lukas, this is what I meant when I asked "has this been changed". Because if it has, there are still going to be workspaces out there created on 0.11.1 and before with the .copybooks folder in a different location.
So no, I don't think we want to be more specific.

I've expanded on this in the "retrieving copybooks" section.

zimlu02 · 2020-06-08T16:17:02Z

README.md


-   **Tip:** Because copybooks that are downloaded to the .copybooks folder might change on the mainframe, we recommend that you refresh your copybooks from time to time. To refresh your copybooks, manually delete the hidden .copybooks folder in your workspace. The copybooks are then re-downloaded from the mainframe the next time you open a file that references each copybook.
+### Storing Copybooks Locally


Could we move this chapter before "Retrieving copybooks from the mainframe"?
Local copybooks are always prioritized over those downloaded from the mainframe. It should be mentioned in the text but also the order of chapters gives users a subconscious impression of the priority.

done in latest commit

zimlu02 · 2020-06-08T16:18:49Z

README.md

-#### Copybook Support Features
+1. Open the **Extensions** tab, click the cog icon next to **COBOL Language Support** and select **Extension Settings** to open the COBOL Language Support extension settings. 
+2. Switch from **User** to **Workspace**.
+3. Under **Paths: Local**, specify the relative paths of the folders containing copybooks.


Don't we want to show the whole syntax here?
Like:
"broadcom-cobol-lsp.cpy-manager.paths.local"

These instructions are for the settings menu with the GUI, not settings.json.

zimlu02 · 2020-06-08T16:19:32Z

README.md

-#### Copybook Support Features
+1. Open the **Extensions** tab, click the cog icon next to **COBOL Language Support** and select **Extension Settings** to open the COBOL Language Support extension settings. 
+2. Switch from **User** to **Workspace**.
+3. Under **Paths: Local**, specify the relative paths of the folders containing copybooks.


list all folders, delimited by comma ...

as above, these are instructions for the extension settings menu, not for settings.json. If you insert a comma separated list into that box it will not work.

zimlu02 · 2020-06-08T16:26:27Z

README.md

@@ -60,22 +60,39 @@ A third-party plugin is required to enable syntax coloring. The Che4z basic stac

 ## Copybook Support

-The LSP for COBOL extension can retrieve copybooks used in your projects from the mainframe and download them locally. You can open copybooks in your IDE and make use of the copybook support features of the extension.
+The COBOL Language Support extension can retrieve copybooks used in your projects from the mainframe and download them locally. You can also store copybooks locally in folders in your workspace. Copybook support features of the extension are enabled whenever a copybook called in source code is successfully located in a specified mainframe data set or local folder.


Add something like: "The COBOL Language Support extension requires all copybooks referred in the code after the 'COPY' statements to be present locally in order to avoid false positives in error check, goto definition etc. They could be either already part of the workspace (e.g. cloned from the GIT repository along with the whole project), added manually into some local folder, or downloaded from mainframe." Check with the team if the local copybooks can be in a diff folder than the current workspace? I don't think so as we support only relative paths now. Also mention that we cover only relative paths.

I already clarified that local copybooks need to be in a workspace folder, and that paths need to be relative. Is this not clear enough from the current procedure under "Storing Copybooks Locally"?

I've reworded the section opening, hope it's clearer now.

asatklichov · 2020-06-09T11:23:20Z

README.md

@@ -60,22 +60,46 @@ A third-party plugin is required to enable syntax coloring. The Che4z basic stac

 ## Copybook Support

-The LSP for COBOL extension can retrieve copybooks used in your projects from the mainframe and download them locally. You can open copybooks in your IDE and make use of the copybook support features of the extension.
+The COBOL Language Support extension supports copybooks called by your source code that are stored in a folder in your workspace. If your copybooks are stored in mainframe data sets, you can use a Zowe CLI z/OSMF profile to automatically download them from the mainframe to your workspace. You specify the local folders and mainframe data sets that contain copybooks used in your project in the workspace settings.


in a folder --> in a local folder.

We are introducing this term, so we firstly need to mention it here.

Done in latest commit

asatklichov · 2020-06-09T11:25:07Z

README.md

@@ -60,22 +60,46 @@ A third-party plugin is required to enable syntax coloring. The Che4z basic stac

 ## Copybook Support

-The LSP for COBOL extension can retrieve copybooks used in your projects from the mainframe and download them locally. You can open copybooks in your IDE and make use of the copybook support features of the extension.
+The COBOL Language Support extension supports copybooks called by your source code that are stored in a folder in your workspace. If your copybooks are stored in mainframe data sets, you can use a Zowe CLI z/OSMF profile to automatically download them from the mainframe to your workspace. You specify the local folders and mainframe data sets that contain copybooks used in your project in the workspace settings.


Technically copybooks are not called, should be either "included" or "used" in your code

Fixed (several occurrences)

temanbrcom · 2020-06-09T11:28:30Z

README.md


-To set up automatic copybook retrieval from the mainframe, **follow these steps:**
+Ensure that copybook names are called in your source code in upper case, for example `COPY BOOK1` and not `COPY book1`. Lower case copybook names are not resolved by the extension and are marked as errors.


Not exactly, copybook names in a copy statement are case insensitive. The user should make sure that the file name in the folder is in the upper case, or it may be not resolved.

Thanks, I've just tested it and this is exactly what happens. Fixed in latest commit.

temanbrcom · 2020-06-09T11:31:07Z

README.md


-#### Retrieving Copybooks
+To enable copybook support, you specify the local folders and mainframe data sets that contain copybooks used in your project in the workspace settings. When a copybook is called in the program, the folders and data sets are searched in the order they are listed for files and members that match the copybook's name. If a copybook with the same file name is located in both a local folder and a mainframe data set, the one in the local folder is used.


It is technically correct, but a little misleading. Retrieving the copybooks from a mainframe will work even without specifying a local folder - they will appear in the predefined one.

Any clearer now?

Maybe, "...you may specify the local folders..." will be enough to show that it is not obligatory. The following text explains the process well.

It is obligatory to specify either folders or data sets. I hope the new opening sentence makes that clear enough. Adding "can" or "may" just makes it sound like the whole thing is optional.

Ok, I agree

temanbrcom · 2020-06-09T11:45:20Z

Please, squash those commits on merge when you finish

Bitlang feature, not ours.

revert, this is our feature

DStatWriter

Looks great, good work Zeb!

asatklichov

👍

* Updates for local copybook support * minor format * Update copybook support section * Add copybook support GIF * Delete cpygotodef.gif * Add copybook support GIF * Delete cpygotodef.gif * Add copybook support GIF * Update copybook support section and add new GIF * Update copybook support section of readme * Update copybook support section * Update copybook support section * Update copybook support section * Update copybook support section * Update copybook support section * Update copybook support section * Update copybook support section * Update copybook support section * Update copybook support section * Update copybook support section * Update copybook support section - remove GIF Bitlang feature, not ours. * Update copybook support section - add GIF revert, this is our feature

* Add test to parse json like settings * Initialize workspace settings.json if not present * fix: Change log archive path pattern to relate on the user directory #307 * fix: Hide 'no errors found' message GH-312 In order to limit showing pop-ups silently log notifications that document analyzed with no errors. * doc: Add committing requirements for contributors Some advice and requirements for contributors to the committing process. * ci: Add integration tests into Jenkins pipeline (#260) Add integration tests to CI/CD. Schedule nightly build conditionally. Ignore failed tests. Signed-off-by: Anton Grigorev <[email protected]> * build: Change "-NEXT" suffix to "+NEXT" Current "-NEXT" is pre-release identifier according the SemVer grammar. After changing to "+NEXT" it will be a build metainfo. This means that 0.11.1+NEXT and 0.11.1 will have the same precedence. Signed-off-by: Anton Grigorev <[email protected]> * fix: Create a .gitignore file if it doesn't exist #329 Signed-off-by: as892333 <[email protected]> * ci: Fix Jenkins deploy stage Using right "workspabe" variable. Signed-off-by: Anton Grigorev <[email protected]> * revert changes Signed-off-by: as892333 <[email protected]> * Add java path to prerequisites in the readme file (#334) * java PATH variable * . * test: Add more test cases like copybooks etc. (#313) Tag 8 failing tests as Unstable. Signed-off-by: Anton Grigorev <[email protected]> * Resolve local URI from settings * Add test to parse json like settings * Add test related to path validation * Refactor function to parse paths and exclude not valid URIs * Introduce URI validation in the Local Copybook Resolver * Add unit test to avoid duplicates in URI list * Minor changes on API * Fix setting key property * Address merge conflicts with development * Address conflict with existent path key in json definition * Add URI normalize to avoid unexpected result - as double slashes * Fix key in order to support zowe and local scenario under common key paths * Fix workspace path * Update API to return URI in the result array * Apply minor enhancement * Address request change * Address request change to readability improvements * ci: Limit the Number of Logs on the Pipeline Logback configuration for unit tests was updated with level = warning. Maven flag do not display transfer progress when downloading was enabled. Fix "Failed to load class org.slf4j.impl.StaticLoggerBinder" Closes #345 Signed-off-by: Anton Grigorev <[email protected]> * ci: Fix integration testing artifacts collecting The folder 'theia_robot_output' was excluded from artifacts collecting set. Artifacts collecting steps was moved from Jenkinsfile to *.sh file. If any 'cp' line fails the script will run to the end successfully. Added copyright to scripts. The selector was added to CopyArtifacts. Otherwise 'copyArtifacts' will copy artifact from the last successful build, not the current. Signed-off-by: Anton Grigorev <[email protected]> * feat: Inform user about wrong credentials and stop sending other MF requests User was correctly notified if: * Zowe profile have empty password * MF API not accessible * Zowe profile have wrong credentials * dataset not found Closes #237 Signed-off-by: Anton Grigorev <[email protected]> * ci: Fix webdriver log name for collection Signed-off-by: Anton Grigorev <[email protected]> * re-organize with .c4z folder and create .gitignore Signed-off-by: as892333 <[email protected]> * "typo" Signed-off-by: as892333 <[email protected]> * "fix: re-organize with .c4z folder and create .gitignore #331" Signed-off-by: Azat Satklichov <[email protected]> * ci: Added Jenkins params to run integration tests (#357) Signed-off-by: Anton Grigorev <[email protected]> * fix: refactor on review #331 Signed-off-by: Azat Satklichov <[email protected]> * Update package-lock * fix: update activation event #331 Signed-off-by: Azat Satklichov <[email protected]> * fix: err-log #331 Signed-off-by: Azat Satklichov <[email protected]> * refactor: Introduce on-demand client configuration calls GH-327 Signed-off-by: Anton Grigorev <[email protected]> * feat: Fetch copybooks without .dep files GH-327 Signed-off-by: Anton Grigorev <[email protected]> * refactor: Clean-up ClientService GH-327 Signed-off-by: Anton Grigorev <[email protected]> * refactor: Move copybook fetch Quick Fix to the server GH-327 * refactor: Interrupt a thread that had an exception #355 * refactor: Remove deprecated settings provider #355 * feat: Introduce dynamic registration for watchers GH-355 * refactor: Make configuration calls async #355 * fix: Fix glob pattern for dynamic registration #355 * tests: Adjust tests to new requirements #355 * tests: Adjust Workspace Service unit test #355 * refactor:Make Watching Service a singleton #355 * test: Adjust Language Server test to the new requirements #355 * test: Remove deprecated tests #355 * test: Add test related to path validation GH-355 * refactor: Exclude invalid URIs on paths parsing GH-355 * refactor: Introduce URI validation in the Local Copybook Resolver GH-355 * refactor: Apply more descriptive name for class and test GH-23 * test: Add unit test to avoid duplicates in URI list GH-355 * test: Polish test suite and minor changes GH-23 * refactor: Minor changes on API naming and documentation GH-355 * refactor: Minor changes on API GH-355 * Address merge conflicts with development * refactor: Address conflict with existent path key in json definition GH-327 * refactor: Add URI normalize to avoid unexpected result - as double slashes GH-355 * Update API to return URI in the result array * feat: Retrieve local copybooks if exists GH-327 * refactor: Adjust variable declaration GH-23 * Test sending local URI from client to server GH-327 * Address request change to readability improvements * Merge remote-tracking branch 'remotes/origin/copybooks-middleware' into fetch-priority # Conflicts: # clients/cobol-lsp-vscode-extension/src/extension.ts # clients/cobol-lsp-vscode-extension/src/services/LanguageClientService.ts * test: Clean unit test for Copybook Resolver GH-355 * refactor: Clean up client part GH-23 * refactor: Refactor Middleware client part (GH-364) Signed-off-by: Anton Grigorev <[email protected]> * refactor: Clean up client part of copybook resolution GH-355 * refactor: Fix middleware issue (GH-365) Signed-off-by: Anton Grigorev <[email protected]> * fix: Fix issue with indirect overwrite settings conf for dsn paths * refactor: Remove obsolete prioritization on the client side * refactor: Fix cobol name extraction (GH-366) Signed-off-by: Anton Grigorev <[email protected]> * refactor: Introduce method to handle responsability for just add missing copybook in the internal queue * test: Add client tests for middleware (GH-367) Filtering fetch copybook events only for didOpen. Signed-off-by: Anton Grigorev <[email protected]> * refactor: Remove unused methods GH-23 * fix: Fix issue related to copybook with extension that were not recognized as valid URI GH-355 * test: Provide a unit test for Watching Service #355 * test: Improve CopybookURI.ts code coverage and address lint of javadoc * Merge branch 'development' into fetch-priority * refactor: Remove deprected tests #355 * test: Improved SettingsUtils unit test * refactor: Delete unused classes GH-23 Signed-off-by: Anton Grigorev <[email protected]> * Merge pull request GH-370 from grianbrcom/fp_fix * refactor: Add File Service to simplify testing GH-355 * refactor: Make URI resolution work with .c4z folder #355 * refactor: Remove deprecated URI resolution #355 * test: Skip not finalized tests #355 * test: Define PathsService.ts unit test GH-355 * refactor: Add check for non-existing copybook file #355 * refactor: Remove unused files GH-23 * refactor: Add missing copyright header GH-23 Signed-off-by: Azat Satklichov <[email protected]> * test: Update test to work with temp folder GH-23 Signed-off-by: Azat Satklichov <[email protected]> * ci: Add Jest treshold for client tests Signed-off-by: Azat Satklichov <[email protected]> * refactor: Remove duplicated method calls GH-23 Signed-off-by: Azat Satklichov <[email protected]> * refactor: Remove POC vsc commands GH-376 * refactor: Invoke handleQueue() from start() GH-376 * refactor: Remove unused function GH-376 * refactor: Use fs API for Node 10x and apply linting GH-376 * refactor: Apply linting GH-23 GH-376 * refactor: Don't resolve copybooks in unregistered local folders GH-355 Invalidate cached URIs when watcher list chagned. * refactor: Rename ClientService to SettingsService Add the header to Middleware.ts Signed-off-by: Anton Grigorev <[email protected]> * refactor: Apply linting GH-23 GH-376 * refactor: Remove dead code #23 * refactor: Remove obsolete code #23 * refactor: Make watchers registration thread-safe GH-355 * refactor: Address request of change GH-376 * refactor: Address request of change GH-23 GH-376 * refactor: Extract monade method to reduce code duplication GH-23 * refactor: Address request of change GH-23 GH-376 * refactor: Move all the posiible settings parameters to one enum #327 * refactor: Make response parsing null safe #327 * refactor: Adjust class indentation #23 * test: Remove folder structure to avoid dirty state #23 * test: Improve code coverage foc CopybookDownloadService * refactor: Adjust fetch copybook command action * test: Improve code coverage for JavaCheck Signed-off-by: Azat Satklichov <[email protected]> * refactor: negative cases extracted to a function Signed-off-by: Azat Satklichov <[email protected]> * refactor: try catch replaced with inline alternative Signed-off-by: Azat Satklichov <[email protected]> * test: improve code coverage for CopybookURI #23 * refactor: change outdated Java version message Signed-off-by: Azat Satklichov <[email protected]> * Clarify copybook retrieval setup procedure (#359) * Update README.md * Update README.md * enhance readme (#344) * test: Add ZoweApi unit tests for client Signed-off-by: Anton Grigorev <[email protected]> * fix: Use sync APIs to create folder and write on file to avoid unexpected behavior * [Doc] Updates for local copybook support (#383) * Updates for local copybook support * minor format * Update copybook support section * Add copybook support GIF * Delete cpygotodef.gif * Add copybook support GIF * Delete cpygotodef.gif * Add copybook support GIF * Update copybook support section and add new GIF * Update copybook support section of readme * Update copybook support section * Update copybook support section * Update copybook support section * Update copybook support section * Update copybook support section * Update copybook support section * Update copybook support section * Update copybook support section * Update copybook support section * Update copybook support section * Update copybook support section - remove GIF Bitlang feature, not ours. * Update copybook support section - add GIF revert, this is our feature * refactor: Move shared local variables in describe function for CopybookDownloadServiceTest #382 * doc: Update README.md file with Linux section (#377) Add the Linux section. Signed-off-by: Maryna Nalbandian <[email protected]> Co-authored-by: DStatWriter <[email protected]> Co-authored-by: Zeibura Kathau <[email protected]> * test: Fix unresolved promises Signed-off-by: Anton Grigorev <[email protected]> * ci: Enable strict mode for jest unhandled rejections Signed-off-by: Anton Grigorev <[email protected]> * ci: Update Jenkins file to run typescript test * [Doc] Updates for local copybook support (#383) * Updates for local copybook support * minor format * Update copybook support section * Add copybook support GIF * Delete cpygotodef.gif * Add copybook support GIF * Delete cpygotodef.gif * Add copybook support GIF * Update copybook support section and add new GIF * Update copybook support section of readme * Update copybook support section * Update copybook support section * Update copybook support section * Update copybook support section * Update copybook support section * Update copybook support section * Update copybook support section * Update copybook support section * Update copybook support section * Update copybook support section * Update copybook support section - remove GIF Bitlang feature, not ours. * Update copybook support section - add GIF revert, this is our feature * refactor: Rename stage to clarify responsibility #386 * test: Fix warnings Signed-off-by: Maryna Nalbandian <[email protected]> Fix warnings, when robot is running. * test: Change tags for tests need update and tests found defects Now we will use tags NEED_UPDATE and DEFECT_OPEN instead of UNSTABLE. They are more strict and descriptive. Signed-off-by: Maryna Nalbandian <[email protected]> * ci: Change excluding tags for Integration tests Now we will use tags NEED_UPDATE and DEFECT_OPEN instead of UNSTABLE. They are more strict and descriptive. Signed-off-by: Maryna Nalbandian <[email protected]> * test: Fix warnings "syntax is deprecated" Fix this warning: [ WARN ] Accessing variable items using '@{LINES}[0]' syntax is deprecated. Use '${LINES}[0]' instead. Signed-off-by: Maryna Nalbandian <[email protected]> * feat: Adjust the info message about missing copybooks #391 The message was adjusted. "Edit datasets" and "Change zowe profile" buttons was replaced with "Change settings" button. The button opens the settings page with and filter it to show only settings related to our plugin. Closes 391 Signed-off-by: Anton Grigorev <[email protected]> * ci: Add waiting to Theia is up First test is always fails in CI because it takes ~30 seconds to Theia be ready. Now it is ~ 3-4 seconds. Signed-off-by: Maryna Nalbandian <[email protected]> * refactor: Delete unused plugin properties #23 Signed-off-by: Anton Grigorev <[email protected]> * fix: Avoid many error messages for copybook downloading #384 The middleware process two calls: resolve URI and download copybook. The server synchronously resolves URI copybooks, not in the server cache during document analysis. After the scan, the server sends one call to middleware with a list of copybooks to download. DoneAnalysisEvent was added to the databus. Closes #384 Signed-off-by: Anton Grigorev <[email protected]> * fix: unexpected Java 8 expected error message #333 (#396) fix: unexpected Java 8 expected error message #333 * fix: Fix representation of settings.json in Theia #393 Signed-off-by: Azat Satklichov <[email protected]> * refactor: Simplify UI for copybook management #384 * refactor: Remove async popup to ask user to select profile #384 * refactor: Remove UI components for handling resolution of copybooks from MF #384 * refactor: update quickfix open settings action with reference to settings.json #382 * refactor: Define API to resolve profile from settings or document with unit tests #382 * refactor: Consume new API in CopybookURI to use new profile API #382 * refactor: Rename Fetch copybook command in Resolve Copybook Command #382 * fix: Avoid many error messages for copybook downloading #384 Doing existing profile check once for all list of downloading copybooks. Not for each copybook individually. Signed-off-by: Anton Grigorev <[email protected]> * fix: Remove popup message, track event in log file #318 * refactor: Change settings paths on the server side #393 * refactor: Add watchers also to folders #395 * test: Fix types of asserted events * Doc: add compatibility section (#407) * build: Remove unused dependency * refactor: Fix sending download requests for nested copybooks #400 * Updates to Readme and Changelog for version 0.12.0 (#409) * Update client readme file * Update CHANGELOG.md * Update CHANGELOG.md * Remove compatibility section from client readme * move to client changelog * Update CHANGELOG.md * Update CHANGELOG.md * remove dupes * changes * chore(release): 0.12.0-alpha.1 # [0.12.0-alpha.1](0.11.1...0.12.0-alpha.1) (2020-07-03) ### Bug Fixes * Avoid many error messages for copybook downloading [#384](#384) ([8f3ab6f](8f3ab6f)) * Avoid many error messages for copybook downloading [#384](#384) ([2e7e394](2e7e394)) * Change log archive path pattern to relate on the user directory [#307](#307) ([9c6c882](9c6c882)) * Create a .gitignore file if it doesn't exist [#329](#329) ([40ca9f7](40ca9f7)) * err-log [#331](#331) ([d830593](d830593)) * Fix glob pattern for dynamic registration [#355](#355) ([7117683](7117683)) * Fix issue related to copybook with extension that were not recognized as valid URI GH-355 ([39169e2](39169e2)), closes [#355](#355) * Fix issue with indirect overwrite settings conf for dsn paths ([1afe039](1afe039)) * Fix representation of settings.json in Theia [#393](#393) ([b4cd52b](b4cd52b)) * Hide 'no errors found' message GH-312 ([6f19c9b](6f19c9b)), closes [#312](#312) * refactor on review [#331](#331) ([4e8e8af](4e8e8af)) * Remove popup message, track event in log file [#318](#318) ([ba33f88](ba33f88)) * unexpected Java 8 expected error message [#333](#333) ([#396](#396)) ([9c224a6](9c224a6)) * update activation event [#331](#331) ([ac65f46](ac65f46)) * Use sync APIs to create folder and write on file to avoid unexpected behavior ([17b8908](17b8908)) ### Features * Adjust the info message about missing copybooks [#391](#391) ([54a3386](54a3386)) * Fetch copybooks without .dep files GH-327 ([098f4bc](098f4bc)), closes [#327](#327) * Inform user about wrong credentials and stop sending other MF requests ([0dc0548](0dc0548)), closes [#237](#237) * Introduce dynamic registration for watchers GH-355 ([0358b95](0358b95)), closes [#355](#355) * Retrieve local copybooks if exists GH-327 ([7d3a068](7d3a068)), closes [#327](#327) Signed-off-by: semantic-release-bot <[email protected]> * chore(release): Switch to development version Signed-off-by: semantic-release-bot <[email protected]> * ci: disable too many notifications from semantic-release tool Disable adding comments to each PR about it is included into the release. Signed-off-by: Anton Grigorev <[email protected]> * reverse to original version of this release * ci: Disable changelog updating on release (#418) Signed-off-by: Anton Grigorev <[email protected]> Co-authored-by: zacanbrcom <[email protected]> Co-authored-by: Filip Kroupa <[email protected]> Co-authored-by: Andrei Temnikov <[email protected]> Co-authored-by: Andrei Temnikov <[email protected]> Co-authored-by: Filip Kroupa <[email protected]> Co-authored-by: grianbrcom <[email protected]> Co-authored-by: Anton Grigorev <[email protected]> Co-authored-by: as892333 <[email protected]> Co-authored-by: Zeibura Kathau <[email protected]> Co-authored-by: Iurii Shchekochikhin <[email protected]> Co-authored-by: Maryna Nalbandian <[email protected]> Co-authored-by: DStatWriter <[email protected]> Co-authored-by: Azat Satklichov <[email protected]> Co-authored-by: semantic-release-bot <[email protected]>

Updates for local copybook support

38ea1f8

zeibura requested review from zacanbrcom, DStatWriter, zimlu02 and temanbrcom June 8, 2020 13:34

zeibura added 8 commits June 8, 2020 16:09

minor format

79a62cf

Update copybook support section

28dc17b

Add copybook support GIF

781171d

Delete cpygotodef.gif

550ecaf

Add copybook support GIF

0e073e3

Delete cpygotodef.gif

82752db

Add copybook support GIF

e5b9247

Update copybook support section and add new GIF

78ea3c8

zimlu02 reviewed Jun 8, 2020

View reviewed changes

Update copybook support section of readme

6c798d7

zimlu02 reviewed Jun 8, 2020

View reviewed changes

zeibura added 7 commits June 9, 2020 12:11

Update copybook support section

7fbd7e5

Update copybook support section

1eb6412

Update copybook support section

2ba26af

Update copybook support section

ad933c2

Update copybook support section

d085f1a

Update copybook support section

bac6c87

Update copybook support section

a65ade4

asatklichov reviewed Jun 9, 2020

View reviewed changes

Update copybook support section

48fa29c

asatklichov reviewed Jun 9, 2020

View reviewed changes

Update copybook support section

37cc758

temanbrcom reviewed Jun 9, 2020

View reviewed changes

temanbrcom assigned zeibura Jun 9, 2020

temanbrcom added the documentation Improvements or additions to documentation label Jun 9, 2020

temanbrcom added this to the 0.12.0 - support copybooks in the local workspace milestone Jun 9, 2020

zeibura added 3 commits June 9, 2020 13:45

Update copybook support section

472baa1

Update copybook support section - remove GIF

5e3e724

Bitlang feature, not ours.

Update copybook support section - add GIF

352c71b

revert, this is our feature

temanbrcom approved these changes Jun 9, 2020

View reviewed changes

DStatWriter approved these changes Jun 9, 2020

View reviewed changes

zeibura requested a review from zimlu02 June 9, 2020 12:45

asatklichov approved these changes Jun 9, 2020

View reviewed changes

zeibura merged commit 9e0a2e3 into development Jun 9, 2020

zeibura deleted the localcopybooks-readme branch June 9, 2020 16:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Doc] Updates for local copybook support #383

[Doc] Updates for local copybook support #383

zeibura commented Jun 8, 2020 •

edited

Loading

zeibura commented Jun 8, 2020

zimlu02 Jun 8, 2020

zeibura Jun 8, 2020

zimlu02 Jun 8, 2020 •

edited

Loading

zeibura Jun 8, 2020

zimlu02 Jun 8, 2020

zeibura Jun 9, 2020 •

edited

Loading

zeibura Jun 9, 2020

zimlu02 Jun 8, 2020

zeibura Jun 8, 2020

zimlu02 Jun 8, 2020

zeibura Jun 8, 2020

zimlu02 Jun 8, 2020

zeibura Jun 8, 2020

zimlu02 Jun 8, 2020

zeibura Jun 8, 2020

zeibura Jun 9, 2020

asatklichov Jun 9, 2020

zeibura Jun 9, 2020

asatklichov Jun 9, 2020

zeibura Jun 9, 2020

temanbrcom Jun 9, 2020

zeibura Jun 9, 2020

temanbrcom Jun 9, 2020

zeibura Jun 9, 2020

temanbrcom Jun 9, 2020

zeibura Jun 9, 2020

temanbrcom Jun 9, 2020

temanbrcom commented Jun 9, 2020

DStatWriter left a comment

asatklichov left a comment


		#### Retrieving Copybooks
		Ensure that copybook names are specified in your source code in upper case, for example `COPY BOOK1` and not `COPY book1`.


		Tip: Because copybooks that are downloaded to the .copybooks folder might change on the mainframe, we recommend that you refresh your copybooks from time to time. To refresh your copybooks, manually delete the hidden .copybooks folder in your workspace. The copybooks are then re-downloaded from the mainframe the next time you open a file that references each copybook.
		### Storing Copybooks Locally


		To set up automatic copybook retrieval from the mainframe, follow these steps:
		Ensure that copybook names are called in your source code in upper case, for example `COPY BOOK1` and not `COPY book1`. Lower case copybook names are not resolved by the extension and are marked as errors.


		#### Retrieving Copybooks
		To enable copybook support, you specify the local folders and mainframe data sets that contain copybooks used in your project in the workspace settings. When a copybook is called in the program, the folders and data sets are searched in the order they are listed for files and members that match the copybook's name. If a copybook with the same file name is located in both a local folder and a mainframe data set, the one in the local folder is used.

[Doc] Updates for local copybook support #383

[Doc] Updates for local copybook support #383

Conversation

zeibura commented Jun 8, 2020 • edited Loading

zeibura commented Jun 8, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zimlu02 Jun 8, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zeibura Jun 9, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

temanbrcom commented Jun 9, 2020

DStatWriter left a comment

Choose a reason for hiding this comment

asatklichov left a comment

Choose a reason for hiding this comment

zeibura commented Jun 8, 2020 •

edited

Loading

zimlu02 Jun 8, 2020 •

edited

Loading

zeibura Jun 9, 2020 •

edited

Loading