You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nuttx.apache.org by GitBox <gi...@apache.org> on 2022/09/15 17:56:02 UTC
[GitHub] [incubator-nuttx] hartmannathan opened a new pull request, #7103: tools/configure.sh: Update USAGE for custom out-of-tree boards
hartmannathan opened a new pull request, #7103:
URL: https://github.com/apache/incubator-nuttx/pull/7103
## Summary
`tools/configure.sh` recognizes two ways to specify a board config:
- `<board-name>:<config-name>` for in-tree boards
- path relative to `TOPDIR` for custom out-of-tree boards
This PR documents this in the script's USAGE text.
Suggested by TimH in mailing list discussion "build board from custom directory" started 15 Sept 2022, archived:
[https://lists.apache.org/thread/7t8k79mm4kxy9cbo7vmybd36nzh94qtd](https://lists.apache.org/thread/7t8k79mm4kxy9cbo7vmybd36nzh94qtd)
## Impact
Improves usage text.
## Testing
None.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] xiaoxiang781216 merged pull request #7103: tools/configure.sh: Update USAGE for custom out-of-tree boards
Posted by GitBox <gi...@apache.org>.
xiaoxiang781216 merged PR #7103:
URL: https://github.com/apache/incubator-nuttx/pull/7103
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] TimJTi commented on pull request #7103: tools/configure.sh: Update USAGE for custom out-of-tree boards
Posted by GitBox <gi...@apache.org>.
TimJTi commented on PR #7103:
URL: https://github.com/apache/incubator-nuttx/pull/7103#issuecomment-1248691864
Bear in mind that a distclean will wipe .config so any settings of paths etc. there become irrelevant…that’s what “did me in”!
From: hartmannathan ***@***.***>
Reply to: apache/incubator-nuttx ***@***.***>
Date: Thursday, 15 September 2022 at 21:17
To: apache/incubator-nuttx ***@***.***>
Cc: TimJTi ***@***.***>, Comment ***@***.***>
Subject: Re: [apache/incubator-nuttx] tools/configure.sh: Update USAGE for custom out-of-tree boards (PR #7103)
"For out-of-tree custom boards: a path relative to TOPDIR to the custom board's configuration directory (e.g. ../mycustomboards/myboardname/config/nsh)."
If CONFIG_ARCH_BOARD_CUSTOM_DIR_RELPATH is not set, then an absolute path is used. See tools/Config.mk:
138 ifeq ($(CONFIG_ARCH_BOARD_CUSTOM_DIR_RELPATH),y)
139 BOARD_DIR ?= $(TOPDIR)$(DELIM)$(CUSTOM_DIR)
140 else
141 BOARD_DIR ?= $(CUSTOM_DIR)
142 endif
Thanks for pointing that out! Will fix...
—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you commented.Message ID: ***@***.***>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] hartmannathan commented on pull request #7103: tools/configure.sh: Update USAGE for custom out-of-tree boards
Posted by GitBox <gi...@apache.org>.
hartmannathan commented on PR #7103:
URL: https://github.com/apache/incubator-nuttx/pull/7103#issuecomment-1254961357
> @hartmannathan let's finish this PR?
@xiaoxiang781216 sure, I will finish it soon
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] hartmannathan commented on pull request #7103: tools/configure.sh: Update USAGE for custom out-of-tree boards
Posted by GitBox <gi...@apache.org>.
hartmannathan commented on PR #7103:
URL: https://github.com/apache/incubator-nuttx/pull/7103#issuecomment-1248569447
> "For out-of-tree custom boards: a path relative to TOPDIR to the custom board's configuration directory (e.g. ../mycustomboards/myboardname/config/nsh)."
>
> If CONFIG_ARCH_BOARD_CUSTOM_DIR_RELPATH is not set, then an absolute path is used. See tools/Config.mk:
>
> ```
> 138 ifeq ($(CONFIG_ARCH_BOARD_CUSTOM_DIR_RELPATH),y)
> 139 BOARD_DIR ?= $(TOPDIR)$(DELIM)$(CUSTOM_DIR)
> 140 else
> 141 BOARD_DIR ?= $(CUSTOM_DIR)
> 142 endif
> ```
Thanks for pointing that out! Will fix...
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] TimJTi commented on pull request #7103: tools/configure.sh: Update USAGE for custom out-of-tree boards
Posted by GitBox <gi...@apache.org>.
TimJTi commented on PR #7103:
URL: https://github.com/apache/incubator-nuttx/pull/7103#issuecomment-1255158540
Yes, I will do that, no problem; once I’m back from holiday 🙂Regards,Tim.On 22 Sep 2022, at 16:59, hartmannathan ***@***.***> wrote:
@xiaoxiang781216 Thanks for the nudge. Ready for review now.
@TimJTi :
Bear in mind that a distclean will wipe .config so any settings of paths etc. there become irrelevant…that’s what “did me in”!
I don't think we have good documentation on how to do custom-out-of-tree boards. Since you're working with an out-of-tree board, would you be willing to write something helpful for including in Documentation? It wouldn't have to be super long and detailed, just how to invoke the configure.sh script, which Kconfig options to set, and gotchas to avoid like distclean wiping the .config!
—Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you were mentioned.Message ID: ***@***.***>
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] hartmannathan commented on pull request #7103: tools/configure.sh: Update USAGE for custom out-of-tree boards
Posted by GitBox <gi...@apache.org>.
hartmannathan commented on PR #7103:
URL: https://github.com/apache/incubator-nuttx/pull/7103#issuecomment-1248574658
> "For out-of-tree custom boards: a path relative to TOPDIR to the custom board's configuration directory (e.g. ../mycustomboards/myboardname/config/nsh)."
>
> If CONFIG_ARCH_BOARD_CUSTOM_DIR_RELPATH is not set, then an absolute path is used. See tools/Config.mk:
>
> ```
> 138 ifeq ($(CONFIG_ARCH_BOARD_CUSTOM_DIR_RELPATH),y)
> 139 BOARD_DIR ?= $(TOPDIR)$(DELIM)$(CUSTOM_DIR)
> 140 else
> 141 BOARD_DIR ?= $(CUSTOM_DIR)
> 142 endif
> ```
Oh I see, the script tries to use a relative path first, followed by an absolute path:
```
configpath=${TOPDIR}/boards/*/*/${boarddir}/configs/${configdir}
if [ ! -d ${configpath} ]; then
# Try direct path used with custom configurations.
configpath=${TOPDIR}/${boardconfig}
if [ ! -d ${configpath} ]; then
configpath=${boardconfig}
if [ ! -d ${configpath} ]; then
echo "Directory for ${boardconfig} does not exist." 1>&2
echo "" 1>&2
echo "Run tools/configure.sh -L to list available configurations." 1>&2
echo "$USAGE" 1>&2
exit 3
fi
fi
fi
```
I missed that the first time.
So the updated text should read something like:
"...a TOPDIR-relative path or an absolute path to the custom board's configuration directory..."
I don't know whether we should document the need for `CONFIG_ARCH_BOARD_CUSTOM_DIR_RELPATH` in the USAGE text. That doesn't seem to be the right place for it.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] xiaoxiang781216 commented on pull request #7103: tools/configure.sh: Update USAGE for custom out-of-tree boards
Posted by GitBox <gi...@apache.org>.
xiaoxiang781216 commented on PR #7103:
URL: https://github.com/apache/incubator-nuttx/pull/7103#issuecomment-1254070314
@hartmannathan let's finish this PR?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] hartmannathan commented on pull request #7103: tools/configure.sh: Update USAGE for custom out-of-tree boards
Posted by GitBox <gi...@apache.org>.
hartmannathan commented on PR #7103:
URL: https://github.com/apache/incubator-nuttx/pull/7103#issuecomment-1248467606
> Might make a small alteration to this:
>
> ...the name of the board in the boards directory and is the name of the board configuration sub-directory (e.g. boardname:nsh), or: For out-of-tree custom boards: a path relative to TOPDIR to the custom board's configuration directory (e.g. ../mycustomboards/myboardname/config/nsh)
Done, please review again! Thanks
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-nuttx] hartmannathan commented on pull request #7103: tools/configure.sh: Update USAGE for custom out-of-tree boards
Posted by GitBox <gi...@apache.org>.
hartmannathan commented on PR #7103:
URL: https://github.com/apache/incubator-nuttx/pull/7103#issuecomment-1255066777
@xiaoxiang781216 Thanks for the nudge. Ready for review now.
@TimJTi :
> Bear in mind that a distclean will wipe .config so any settings of paths etc. there become irrelevant…that’s what “did me in”!
I don't think we have good documentation on how to do custom-out-of-tree boards. Since you're working with an out-of-tree board, would you be willing to write something helpful for including in Documentation? It wouldn't have to be super long and detailed, just how to invoke the configure.sh script, which Kconfig options to set, and gotchas to avoid like distclean wiping the .config!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org