From 762edda5a4bac0323c45d3682291d4fab15af73d Mon Sep 17 00:00:00 2001 From: Hayato Kiwata <44946173+haytok@users.noreply.github.com> Date: Wed, 20 Dec 2023 03:55:33 +0900 Subject: [PATCH] =?UTF-8?q?docs:=20Update=20a=20link=20for=20the=20struct?= =?UTF-8?q?=20link=20with=20a=20full=20list=20of=20configura=E2=80=A6=20(#?= =?UTF-8?q?714)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit …tion options for ${HOME}/.finch/finch.yaml At this time, the following "the struct here" link in README.md was not updated. ``` For a full list of configuration options, check the struct here. ``` Therefore, this commit fixes the "the struct here" link to link the updated struct code. Issue #, if available: N/A *Description of changes:* Detail are described in the commit message. *Testing done:* N/A - [x] I've reviewed the guidance in CONTRIBUTING.md #### License Acceptance By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. --------- Signed-off-by: Hayato Kiwata --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d45ea8e9e..d87f43dc2 100644 --- a/README.md +++ b/README.md @@ -97,7 +97,7 @@ The installer will install Finch and its dependencies in its own area of your sy Finch has a simple and extensible configuration. A configuration file at `${HOME}/.finch/finch.yaml` will be generated on first run. Currently, this config file has options for system resource limits for the underlying virtual machine. These default limits are generated dynamically based on the resources available on the host system, but can be changed by manually editing the config file. -For a full list of configuration options, check [the struct here](pkg/config/config.go#L30). +For a full list of configuration options, check [the struct here](https://github.com/runfinch/finch/blob/main/pkg/config/config.go#L34). An example `finch.yaml` looks like this: