buglwIP - A Lightweight TCP/IP stack - Bugs: bug #58194, contrib build documentation...

 
 

You are not allowed to post comments on this tracker with your current authentication level.

bug #58194: contrib build documentation missing (lwipcfg.h.example user copy)

Submitter:  Steve Wartik <spwartik>
Submitted:  Fri 17 Apr 2020 12:14:07 PM UTC
   
 
Category:  Contrib Severity:  3 - Normal
Item Group:  None Status:  Fixed
Privacy:  Public Assigned to:  goldsimon
Open/Closed:  Closed Planned Release:  2.2.0
lwIP version:  git head

Jump to the original submission

Thu 22 Dec 2022 09:06:21 PM UTC, comment #10: 


> Sadly, those instructions are out-of-date and incomplete. [There are other problems besides the lwipcfg.h omission.]


Well, thanks for sharing the details ;-)

I've changed and fixed what I've found, I'd be glad if you would share with us what else is out-of-date and incomplete.

Simon Goldschmidt <goldsimon>
Group administrator
Thu 30 Sep 2021 04:04:22 PM UTC, comment #9: 

I just ran into this same problem while trying to follow
the instructions in

  https://git.savannah.nongnu.org/cgit/lwip.git/tree/BUILDING

Sadly, those instructions are out-of-date and incomplete. [There are other problems besides the lwipcfg.h omission.]

If filing bugs and submitting patches isn't the way to get
things fixed/updated, what is?

Grant Edwards <grant>
Tue 21 Apr 2020 04:56:22 PM UTC, comment #8: 

Oops.

It's there now.

Steve Wartik <spwartik>
Tue 21 Apr 2020 04:13:28 PM UTC, comment #7: 

Hello Steve,

Looks like you forgot to attach the patch :-)

Sylvain

Sylvain Rochet <gradator>
Group Member
Mon 20 Apr 2020 03:34:25 PM UTC, comment #6: 

Sylvain,

After reviewing the repository, I concluded I'd be in over my head if I tried to modify the documentation.  Here's an alternative proposal.  I've attached a patch that revises contrib/ports/unix/example_app/CMakeLists.txt.  It now prints a warning message if lwipcfg.h isn't present when you run cmake.

Revising the documentation would be better, but this patch would have saved me some confusion when I tried to compile the code.

Steve

Steve Wartik <spwartik>
Fri 17 Apr 2020 01:37:40 PM UTC, comment #5: 

Sylvain,

I'm new to liIP, but familiar enough with portability to recognize the complexity of proper documentation. I'll study the existing files and, if I can think of something meaningful, I'll contribute it.  Thanks for all your explanations.

Steve

Steve Wartik <spwartik>
Fri 17 Apr 2020 12:56:27 PM UTC, comment #4: 

Hello Steve,

It is indeed badly documented, especially since the switch to cmake, the merge of win32 and unix examples and the merge of contrib to the main repository the documentation that was in contrib seem to be out of date, making it harder than ever for newcomers.

I guess the previous reference telling users to rename the config file lives in ./contrib/ports/win32/readme.txt, at the wrong place, and with a wrong filename:

  You also will have to copy the file 'lwipcfg_msvc.h.example' to
  'lwipcfg_msvc.h' and modify to suit your needs (WinPcap adapter number,
  IP configuration, applications...).

I'm not confident enough to do those documentation changes, I kind of lost track of lwIP during the contrib merge and I'm not really sure what should be done :-)

Sylvain

Sylvain Rochet <gradator>
Group Member
Fri 17 Apr 2020 12:25:12 PM UTC, comment #3: 

Sylvain,

Thanks for the quick response.  Is this documented?  If not I'll be happy to contribute a README.

Steve Wartik <spwartik>
Fri 17 Apr 2020 12:22:17 PM UTC, comment #2: 

I submitted that bug report for the sake of reporting a compilation issue.  Poking around, I see that lwipcfg.h.* files exist in contrib/examples/example_app. Where are the instructions that turn these files into lwipcfg.h?

Steve Wartik <spwartik>
Fri 17 Apr 2020 12:21:35 PM UTC, comment #1: 

Hello Steve,

You have to rename ./contrib/examples/example_app/lwipcfg.h.example to lwipcfg.h.

We do so so to prevent overwriting or conflict with your local changes when updating the repository.

Sylvain

Sylvain Rochet <gradator>
Group Member
Fri 17 Apr 2020 12:14:07 PM UTC, original submission:  

I just cloned the repository and tried to build it on Ubuntu 18.04. I executed:

$ cmake -S . -B build
$ cmake --build build

I received the error:

[ 98%] Building C object contrib/ports/unix/example_app/CMakeFiles/example_app.dir/__/__/__/examples/example_app/test.c.o
/home/ilab-user/src/lwip/lwip/contrib/examples/example_app/test.c:110:10: fatal error: lwipcfg.h: No such file or directory
 #include "lwipcfg.h"

From the repository's root directory, I executed:

$ find . -name lwipcfg.h

and verified that this file is not in the repository.

Steve Wartik <spwartik>

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attached Files

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by goldsimon (Updated the item)
  • -email is unavailable- added by grant (Posted a comment)
  • -email is unavailable- added by gradator (Posted a comment)
  • -email is unavailable- added by spwartik (Submitted the item)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

     

    Follow 10 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2022-12-22 goldsimon StatusConfirmed Fixed
        Assigned toNone goldsimon
        Open/ClosedOpen Closed
    2022-02-16 goldsimon Planned ReleaseNone 2.2.0
    2020-04-21 spwartik Attached File- Added 0001-Added-warning-to-cmake-instructions-when-lwipcfg.h-i.patch, #48895
    2020-04-21 gradator StatusInvalid Confirmed
    2020-04-17 gradator Open/ClosedClosed Open
        SummaryMissing lwipcfg.h contrib build documentation missing (lwipcfg.h.example user copy)
    2020-04-17 gradator StatusNone Invalid
        Open/ClosedOpen Closed

    Back to the top

    Powered by Savane 3.13-d3ae.
    Corresponding source code