Opened 2 years ago

Closed 20 months ago

#590 closed Patch submission (fixed)

INSTALL document patch plus New Document (pending review by OpenVPN-devel)

Reported by: dogbert2 Owned by: samuli
Priority: minor Milestone: release 2.3.11
Component: Documentation Version: OpenVPN 2.3.8 (Community Ed)
Severity: Not set (select this one, unless your'e a OpenVPN developer) Keywords: Documentation
Cc:

Description

Hi All,

After a few mighty tries, OpenVPN-2.3.8 is built with OpenSSL-1.0.2d and LZO-2.0.9 (sorry about ticket #589), but in reviewing the documentation, it could be more clear, so what I have done is made a patch file for INSTALL which is INSTALL.patch, and wrote a draft for a document called INSTALL.nonstandard which should clarify installing OpenVPN against user-built OpenSSL/LZO, etc.

Let me know what you think...

Attachments (2)

INSTALL.patch (1.7 KB) - added by dogbert2 2 years ago.
Patch file for INSTALL file in OpenVPN 2.3.8
INSTALL-nonstandard.txt (4.8 KB) - added by dogbert2 2 years ago.
New INSTALL document for OpenVPN 2.3.8

Download all attachments as: .zip

Change History (7)

Changed 2 years ago by dogbert2

Patch file for INSTALL file in OpenVPN 2.3.8

Changed 2 years ago by dogbert2

New INSTALL document for OpenVPN 2.3.8

comment:1 Changed 2 years ago by cron2

  • Milestone set to release 2.3.9

As your ticket subject says - "pending review by openvpn-devel" :-) - so please send the patch to openvpn-devel@…, as that's the standard workflow to get patches reviewed and merged.

And thanks for the work, btw, as I have to agree that INSTALL is not exactly complete here, and truly needs improvement!

comment:2 Changed 2 years ago by cron2

  • Owner set to samuli
  • Status changed from new to assigned

feeling lazy today, throwing at samuli "he's good with documentation and build instructions"... if we can't make use of this for 2.3.9, feel free to bump to 2.3.10 or 2.3.11.

(As a side note: the additions are good, but not all technically correct - PAM is only needed for plugin-auth-pam, so if you disable plugins, it is not *required*. The INSTALL-nonstandard has a few typos... and I'm not sure this really needs to be a separate file)

comment:3 Changed 2 years ago by cron2

Whee... this should be fixed as well, in INSTALL in release/2.3...

git checkout -b 2.2 remotes/origin/release/2.2

comment:4 Changed 20 months ago by samuli

  • Milestone changed from release 2.3.9 to release 2.3.11

I sent the attached patch to the mailing list. When that goes in (as-is, or in modified form) we can close this ticket.

comment:5 Changed 20 months ago by samuli

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

We discussed this patch in today's IRC meeting. It has now been merged to release/2.3. The INSTALL file in Git "master" needs quite a bit more work, so this patch won't go there in its current form.

Note: See TracTickets for help on using tickets.