zowe / launcher

Eclipse Public License 2.0
0 stars 4 forks source link

Launcher error codes outdated #71

Open 1000TurquoisePogs opened 1 year ago

1000TurquoisePogs commented 1 year ago

https://docs.zowe.org/stable/troubleshoot/launcher/launcher-error-codes needs updating

Martin-Zeithaml commented 1 year ago

Either use some existing generator for automatic documentation or we can simply read something like this (just an idea):

...
#define MSG_COMP_STARTED        MSG_PREFIX "0001I" " component %s started\n"
//@Reason: Component `<component-name>` started.
//@Action:
#define MSG_COMP_STOPPED        MSG_PREFIX "0002I" " component %s stopped\n"
//@Reason: Component `<component-name>` stopped.
//@Action:
#define MSG_COMP_INITED         MSG_PREFIX "0003I" " new component initialized %s, restart_cnt=%d, min_uptime=%d seconds, share_as=%s\n"
//@Reason: Component `<component-name>` initialized.
//  - `restart_cnt` - Number of attempts to restart the component in case of failure
//  - `min_uptime` - Minimum uptime that the component can be considered as successfully started
//  - `share_as` - One of `<yes|no|must>` which indicates whether child processes of the component start in the same address space. See documentation for [_BPX_SHAREAS](https://www.ibm.com/docs/en/zos/2.4.0?topic=shell-setting-bpx-shareas-bpx-spawn-script) for details.
//@Action:
#define MSG_COMP_TERMINATED     MSG_PREFIX "0004I" " component %s(%d) terminated, status = %d\n"
//@Reason:  Component `<component-name>`(`<pid>`) terminated with status `<code>`.
//@Action:
#define MSG_NEXT_RESTART        MSG_PREFIX "0005I" " next attempt to restart component %s in %d seconds\n"
//@Reason: Component failure detected.
//@Action: No action required. The component `<component-name>` will be restarted in `<n>` seconds.
...
Martin-Zeithaml commented 1 year ago

I will (at least) start with documentation 😃

Martin-Zeithaml commented 1 year ago

There is a PR3057 for this, but: