Skip to content

Add the documents about configuration parameters #665

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from

Conversation

tsh-hashimoto
Copy link
Contributor

This pull request introduces a new documentation file, configuration-params-JP.md, that explains configuration parameters for opensource COBOL 4J. It also updates README.md and README_JP.md to link to this new documentation. The most significant change is the addition of detailed explanations for each configuration parameter, including their default values, possible settings, and descriptions.

Documentation Updates:

  • New Documentation File: Added doc/confifuration-params-JP.md to provide comprehensive details about OpenCOBOL 4J configuration parameters, including default values, descriptions, and supported options. This file covers 63 parameters and their usage.
  • README Links: Updated README.md and README_JP.md to include links to the new configuration-params-JP.md documentation file. [1] [2]

@tsh-hashimoto tsh-hashimoto requested a review from Copilot June 13, 2025 06:37
Copilot

This comment was marked as outdated.

@tsh-hashimoto tsh-hashimoto requested a review from Copilot June 13, 2025 06:45
Copilot

This comment was marked as outdated.

@tsh-hashimoto tsh-hashimoto requested a review from Copilot June 13, 2025 06:52
Copilot

This comment was marked as outdated.

@tsh-hashimoto tsh-hashimoto requested a review from Copilot June 13, 2025 06:55
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request adds comprehensive documentation for configuration parameters in COBOL 4J and updates the README files to link to the new document.

  • Added a new documentation file (configuration-params-JP.md) detailing 63 configuration parameters.
  • Updated both README_JP.md and README.md files to include a link to the new documentation.

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
doc/configuration-params-JP.md New documentation file listing configuration parameters and their details.
README_JP.md Updated link to the new configuration parameters documentation.
README.md Updated link to the new configuration parameters documentation.
Comments suppressed due to low confidence (1)

doc/configuration-params-JP.md:30

  • The allowed value list for the 'binary-size' parameter includes '1--8' with a double hyphen, which may be a typographical error. Please verify if the intended value is different.
| 11 | binary-size | `2-4-8`, `1-2-4-8`, `1--8` | `1-2-4-8` | `PIC 9(n) BINARY`の変数が確保するバイト数を設定する | |

@tsh-hashimoto tsh-hashimoto changed the title docs: add the documents about configuration parameters Add the documents about configuration parameters Jun 13, 2025
@tsh-hashimoto tsh-hashimoto marked this pull request as ready for review June 13, 2025 07:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants