Opened 5 years ago

Closed 5 years ago

#260 closed Patch submission (fixed)

Fix parameter listing in non-debug builds at verb 4

Reported by: JoshC Owned by:
Priority: major Milestone: release 2.3
Component: Building / Compiling Version: OpenVPN 2.3.0 (Community Ed)
Severity: Patch Queue: New / awaiting ACK Keywords: verb enable_debug enable_small parameter
Cc:

Description (last modified by JoshC)

I'll attach the patch here. For full details, see the mailing list entry at: http://article.gmane.org/gmane.network.openvpn.devel/7361 .

I've included the summary here. Patch provided below (same as on the mailing list attachment.)

The current official Windows builds of 2.3.0 up to I004 are built enable_debug=no; I'm not sure about the repo builds since I build from source on my non-Windows systems, but the same issue is present when lacking debug support on Linux/Unix?. This causes such builds to lack parameter printing at --verb 4 which conflicts with the help output and configure text for enable_small. This is a particular issue for binary installations (Windows, or binary *nix distros.)

Attachments (1)

0001-Fix-verb4-with-non-debug.patch (4.6 KB) - added by JoshC 5 years ago.
Fix parameter listing in non-debug builds at verb 4

Download all attachments as: .zip

Change History (4)

Changed 5 years ago by JoshC

Fix parameter listing in non-debug builds at verb 4

comment:1 Changed 5 years ago by JoshC

  • Description modified (diff)
  • Version changed from 2.2.2 to 2.3.0

comment:2 Changed 5 years ago by JoshC

This text was originally from the mailing list email, but I've added it here for completeness as well:

Until this change makes its way into the release repo branches, I'd suggest
all official builds be built with enable_debug=yes. Without this build option,
end-users will be unable to make use of increased verbosity/troubleshooting
provided at verb 4.

comment:3 Changed 5 years ago by dazo

  • Resolution set to fixed
  • Status changed from new to closed

The following patches have been applied. Will be part of 2.3.1

commit 152ca3e49f14b8fe8e7e52daf3cf11851fb98acd
Author: Josh Cepek <josh.cepek@usa.net>
Date:   Wed Mar 20 13:22:25 2013 -0500

    (updated) [PATCH] Warn when using verb levels >=7 without debug
    
    On 3/20/2013 11:42, Arne Schwabe wrote:
    
    > ACK. But I would change "debug verb" to "debug verbosity" and I think
    > there should be no comma before "but"
    
    This text change makes sense: I've adjusted it to read "NOTE: debug
    verbosity..." and saved another byte removing the comma.
    
    Updated patch attached.
    
    --
    Josh
    
    >From d41a0237220f2fea6647a508a2ab07263e0f160b Mon Sep 17 00:00:00 2001
    From: Josh Cepek <josh.cepek@usa.net>
    Date: Tue, 19 Mar 2013 22:52:12 -0500
    Subject: [PATCH] Warn when using verb levels >=7 without debug
    
    This patch adds a log warning when using --verb levels at 7 or higher
    when running on builds lacking debug support. Since official builds are
    now built with enable_debug=no, this warning will help developers
    identify why expected debug messages may not be present in log output.
    
    The test and message output code is omitted when built with
    enable_debug=yes or enable_small=yes.
    
    Signed-off-by: Josh Cepek <josh.cepek@usa.net>
    Acked-by: Arne Schwabe <arne@rfc2549.org>
    Message-Id: <kicup2$gfv$1@ger.gmane.org>
    URL: http://article.gmane.org/gmane.network.openvpn.devel/7425
    Signed-off-by: Gert Doering <gert@greenie.muc.de>
    (cherry picked from commit 58fbb8046b203ca23708c1765ee84330d8809266)

commit c4358645fb37b7c4d9c82c0b7b8b4f17ec4cf326
Author: Josh Cepek <josh.cepek@usa.net>
Date:   Thu Feb 21 09:50:38 2013 -0600

    Fix parameter listing in non-debug builds at verb 4
    
    When built with enable_debug=no, the parameter output expected at --verb
    4 is not printed due to use of #ifdef ENABLE_DEBUG in the responsible
    code sections. This appears to be a mistake when looking at the
    configure help text for enable_small and enable_debug.
    
    This change keys the relevant code off of enable_small instead,
    including the parameter listing when enale_small=no (the
    configure-script default.) Most of this code is in options.c, with some
    callers present in plugin.c/h and route.c/h. No function code is
    changed, just the #ifdef values to use the small feature instead of
    debug.
    
    This means builds no longer need enable_debug=yes in order to get the
    expected log output at verb 4.
    
    Signed-off-by: Josh Cepek <josh.cepek@usa.net>
    Acked-by: Arne Schwabe <arne@rfc2549.org>
    Message-Id: <437RBuq1U8032S07.1361465626@web07.cms.usa.net>
    URL: http://article.gmane.org/gmane.network.openvpn.devel/7361
    Signed-off-by: Gert Doering <gert@greenie.muc.de>
    (cherry picked from commit 6c61d0dd339084175f6911d8b713faaf4967ca03)
Note: See TracTickets for help on using tickets.