The custom option is not always show in menu

[fripSide]

Xmake Version

xmake v2.6.3+master.967769fd1

Operating System Version and Architecture

Windows 10

Describe Bug

When I add a custom option in the xmake.lua, it sometimes failed to show the option in menu (xmake f -h) and I can not pass it via command line.

option("NRF_SDK")
	set_default("")
	set_showmenu(true)
option_end()

local nrf_sdx_path = get_config("NRF_SDK")

I try to set it via the command line. Most of the time, this command may be failed. But sometimes it can successfully get the config.

$ xmake f -p cross -a cortex-m4 --sdk="compile_sdk_path"     --NRF_SDK="dev_sdk_path" -c
error: Invalid option: --NRF_SDK=F:\IoT\SDK\nRF5_SDK_17.1.0_ddde560

I seem to have found out the differences. When I write in this way, it can succeed.

option("NRF_SDK")
	set_default("")
	set_showmenu(true)
option_end()

local nrf_sdx_path = get_config("NRF_SDK") or ""

Otherwise, it may fail when I make the following changes.

-- local nrf_sdx_path = get_config("NRF_SDK") or ""
++ local nrf_sdx_path = get_config("NRF_SDK")

option("NRF_SDK")
	set_default("")
	set_showmenu(true)
option_end()

local nrf_sdx_path = get_config("NRF_SDK")

Expected Behavior

The NRF_SDK option should be successfully set by the command line. But I can only succeed in one of 10 tries without any modifications.

xmake f -NRF_SDK=xxxx_path

Project Configuration

includes("armgcc.lua")

set_toolchains("arm-gcc")

option("NRF_SDK")
	set_default("")
	set_showmenu(true)
option_end()

local nrf_sdx_path = get_config("NRF_SDK") or ""
local nrf_includes = {
	"/components", "/modules/nrfx/mdk", "/components/libraries/fifo", 
}

print("Run build----------")

for _, p in ipairs(nrf_includes) do
	add_includedirs(nrf_sdx_path..p)
	-- print(nrf_sdx_path..p)
end

target("nrf-sdk-lib")
	set_kind("static")
	add_rules("arm-gcc")

target("nrf-app")
	set_kind("binary")
	add_files("src/*.c")
	add_includedirs("include")
	add_rules("arm-gcc")

Additional Information and Error Logs

The problem seems to be the xmake.lua is run many times in each command.

option("NRF_SDK")
	set_default("")
	set_showmenu(true)
option_end()

local nrf_sdx_path = get_config("NRF_SDK") or ""
local nrf_includes = {
	"/components", "/modules/nrfx/mdk", "/components/libraries/fifo", 
}

print("Run build----------")

for _, p in ipairs(nrf_includes) do
	add_includedirs(nrf_sdx_path..p)
	-- print(nrf_sdx_path..p)
end

$ xmake f --NRF_SDK=xxxxx
Run build----------
Run build----------F:\IoT\SDK\nRF5_SDK_17.1.0_ddde560
Run build----------F:\IoT\SDK\nRF5_SDK_17.1.0_ddde560

The option is not always loaded and the string contact may be nil. Then the xmake -f --NRF_SDK=xxx failed with an error message of "error: Invalid option: --NRF_SDK"

-- sometimes be nil
local nrf_sdx_path = get_config("NRF_SDK")  
add_includedirs(nrf_sdx_path..p) 

[waruqi]

这不是 bug，你得使用 option_end ，否则下面的所有 add_includedirs 都是对之前的 option 的设置，而不是 target

或者可以用 option("", {default = true, description = "xxx", showmenu = true}) 自动 option end

多次执行问题，建议先看下 https://xmake.io/#/zh-cn/guide/syntax_description 文档里面有特别描述，不要在描述域去 print 调试。

[fripSide]

这是重现bug的最小用例：

option("NRF_SDK")
	set_default(nil)
	set_showmenu(true)
option_end()

local nrf_sdx_path = get_config("NRF_SDK") or ""

if nrf_sdx_path == "" then
     print("NRF_SDK is not set")
end

add_includedirs(nrf_sdx_path)

执行命令：

$ xmake f --NRF_SDK=xxx
NRF_SDK is not set
...
error: Invalid option: --NRF_SDK=xxxx

是add_includedir("")报错，但是信息却显示是：“error: Invalid option: --NRF_SDK=xxxx”，导致 xmake f --NRF_SDK=xxx无法成功。

[fripSide]

如果你这里能早点显示正确的错误信息，就不会浪费我这么久了。。。。。

@waruqi ，这里深层次的bug是，xmake一下，这个脚本要被执行n次，前面几次执行 option没有初始化。并且报错信息有问题。

现在只能这样写：

if nrf_sdx_path == "" then
	print("NRF_SDK is not set")
else
	add_includedirs(nrf_sdx_path)
end

[waruqi]

这个目前无解，逻辑比较复杂，暂时解不了。

其实是有错误提示的，只是被后面的 menu 刷屏了而已。。你可以翻到最上面看下

$ xmake f --test=xx
error: @programdir/core/base/interpreter.lua:357: add_includedirs(): invalid path value at ./xmake.lua:10
stack traceback:
    [C]: in function 'error'
    [@programdir/core/base/os.lua:849]:
    [@programdir/core/base/interpreter.lua:357]: in function '_api_translate_paths'
    [@programdir/core/base/interpreter.lua:1424]:
    [./xmake.lua:10]: in main chunk

xmake v2.6.4+HEAD.9361ffc, A cross-platform build utility based on Lua
Copyright (C) 2015-present Ruki Wang, tboox.org, xmake.io
                         _
    __  ___ __  __  __ _| | ______
    \ \/ / |  \/  |/ _  | |/ / __ \
     >  <  | \__/ | /_| |   <  ___/
    /_/\_\_|_|  |_|\__ \|_|\_\____|
                         by ruki, xmake.io
    
    👉  Manual: https://xmake.io/#/getting_started
    🙏  Donate: https://xmake.io/#/sponsor
    

Usage: $xmake config|f [options] [target]

Configure the project.

。。。。

error: Invalid option: --test=xx

如果不指定这个 参数，直接执行 xmake f 或者直接执行 xmake 都是可以立马报出这个错误的。。

$ xmake f
error: @programdir/core/base/interpreter.lua:357: add_includedirs(): invalid path value at ./xmake.lua:10
stack traceback:
    [C]: in function 'error'
    [@programdir/core/base/os.lua:849]:
    [@programdir/core/base/interpreter.lua:357]: in function '_api_translate_paths'
    [@programdir/core/base/interpreter.lua:1424]:
    [./xmake.lua:10]: in main chunk

$ xmake
error: @programdir/core/base/interpreter.lua:357: add_includedirs(): invalid path value at ./xmake.lua:10
stack traceback:
    [C]: in function 'error'
    [@programdir/core/base/os.lua:849]:
    [@programdir/core/base/interpreter.lua:357]: in function '_api_translate_paths'
    [@programdir/core/base/interpreter.lua:1424]:
    [./xmake.lua:10]: in main chunk

[fripSide]

好的，谢谢。现在仔细看前面是有报错信息。第一次遇到这问题，还以为是我的option用的不对，一顿瞎改其他代码，有时候碰巧把include改好了不报错，有时候报错。当时觉得很玄学。

[waruqi]

这块是应该改进下，刷屏不太容易看到，后面可以看看把错误挪到底部显示

[waruqi]

这里深层次的bug是，xmake一下，这个脚本要被执行n次，前面几次执行 option没有初始化。并且报错信息有问题。

多次执行，并且结果不同，这不是bug，文档有详细说明。。目前就是这么设计的，描述域不同阶段 解析的内容不同，所以不要去描述域 print 任何东西，也不要去看任何打印的值，没有任何意义的。。

要 print 各种状态，请到 on_load 脚本域调