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

Outdated documentation about tcp-pi requiring 1 KiB of extra memory #715

Closed
psychon opened this issue Sep 5, 2023 · 1 comment
Closed

Comments

@psychon
Copy link

psychon commented Sep 5, 2023

libmodbus version

$ pkg-config --modversion libmodbus
Package libmodbus was not found in the pkg-config search path.
Perhaps you should add the directory containing `libmodbus.pc'
to the PKG_CONFIG_PATH environment variable
Package 'libmodbus', required by 'virtual:world', not found

OS and/or distribution

$ cat /etc/os-release 
PRETTY_NAME="Debian GNU/Linux trixie/sid"
NAME="Debian GNU/Linux"
VERSION_CODENAME=trixie
ID=debian
HOME_URL="https://www.debian.org/"
SUPPORT_URL="https://www.debian.org/support"
BUG_REPORT_URL="https://bugs.debian.org/"

Environment

$ uname -a
Linux ZweiLED 6.4.0-3-amd64 #1 SMP PREEMPT_DYNAMIC Debian 6.4.11-1 (2023-08-17) x86_64 GNU/Linux

Description

Since #621 / commit ef3c4bc, modbus_new_tcp_pi no longer statically allocates 1 KiB of memory, but only as much as is actually required. (This was previously done through the array of size _MODBUS_TCP_PI_NODE_LENGTH in struct _modbus_tcp_pi).

However, the docs were not updated.

Actual behavior if applicable

libmodbus/docs/index.md

Lines 109 to 110 in b25629b

Contrary to the TCP IPv4 only backend, the TCP PI backend offers hostname
resolution but it consumes about 1 kB of additional memory.

Expected behavior or suggestion

Contrary to the TCP IPv4 only backend, the TCP PI backend offers hostname 
resolution.

Steps to reproduce the behavior (commands or source code)

Compare the docs with what the implementation actually does.

libmodbus output with debug mode enabled

Uhm... Command not found, I guess.

@psychon
Copy link
Author

psychon commented Jul 17, 2024

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant