Skip to content
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

CONFIG_CONSOLE_SYSLOG and CONFIG_SYSLOG_CONSOLE are misleading #12767

Open
raiden00pl opened this issue Jul 25, 2024 · 2 comments
Open

CONFIG_CONSOLE_SYSLOG and CONFIG_SYSLOG_CONSOLE are misleading #12767

raiden00pl opened this issue Jul 25, 2024 · 2 comments
Labels
breaking change This change requires a mitigation entry in the release notes. Type: Improvement

Comments

@raiden00pl
Copy link
Contributor

These options are misleading.

All other console enable options have the format like CONFIG_{device_name}_CONSOLE, but for SYSLOG it is CONFIG_CONSOLE_SYSLOG. Moreover there is CONFIG_SYSLOG_CONSOLE option but it has different purpose than other options with format CONFIG_{device_name}_CONSOLE.

config SYSLOG_CONSOLE
	bool "Log to /dev/console"
	default !ARCH_LOWPUTC && !SYSLOG_CHAR && !RAMLOG_SYSLOG && !SYSLOG_RPMSG && !SYSLOG_RTT
	depends on DEV_CONSOLE
	---help---
		Use the system console as a SYSLOG output device.
config CONSOLE_SYSLOG
	bool "Use SYSLOG for /dev/console"
	default n
	depends on DEV_CONSOLE && !SYSLOG_CONSOLE
	---help---
		Use the syslog logging device as a system console. If this feature is
		enabled (along with DEV_CONSOLE), then all console output will be
		re-directed to syslog output (syslog_putc). This is useful, for
		example, if the only console is a Telnet console.  Then in that case,
		console output from non-Telnet threads will go to the syslog output.
@raiden00pl raiden00pl added breaking change This change requires a mitigation entry in the release notes. Type: Improvement labels Jul 25, 2024
@acassis
Copy link
Contributor

acassis commented Jul 25, 2024

I think CONFIG_CONSOLE_SYSLOG actually should be called CONFIG_SYSLOG_CONSOLE and actual CONFIG_SYSLOG_CONSOLE should be rename to CONFIG_SYSLOG_CONSOLE_FOR_LOG.

I think it is a good ideal to keep the consistence "CONFIG_{device_name}_CONSOLE" because we could create a CI check to detect two or more "*_CONSOLE " in defconfig and avoid include it into mainline.

@raiden00pl
Copy link
Contributor Author

I agree that consistency is important, but on the other hand this change will break many user configs, so it will be important to document it well

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change This change requires a mitigation entry in the release notes. Type: Improvement
Projects
None yet
Development

No branches or pull requests

2 participants