From patchwork Mon Oct 13 16:03:39 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Gert Doering X-Patchwork-Id: 4504 Return-Path: Delivered-To: patchwork@openvpn.net Received: by 2002:a05:7000:7d42:b0:72f:f16c:e055 with SMTP id fr2csp2007028mab; Mon, 13 Oct 2025 09:04:03 -0700 (PDT) X-Forwarded-Encrypted: i=2; AJvYcCUygPQx8+U9/cmSrn3opyDJ3SAOV+s3OpO6vElXxS72W1wQqwbo1LXaM35Xzsf2GMtQWfBZBjtR+a8=@openvpn.net X-Google-Smtp-Source: AGHT+IGJXwwRojVJm6J0kmq0Bj0LLpdYLZojgZEDayJGg0S9+PK0SLvFfFlLGcmEQZR0XYBhA6Qq X-Received: by 2002:a05:6808:1a27:b0:43f:5e26:6640 with SMTP id 5614622812f47-4417b2c487dmr8974756b6e.3.1760371442902; Mon, 13 Oct 2025 09:04:02 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1760371442; cv=none; d=google.com; s=arc-20240605; b=iwfLGx6c4Z1I3Ia1LITMGOp+DqTlFssyRPn49js1/IeFOZdWBKUoDoEkkUvJCgmhoF jOFTpDQjnQjIowbLwxeYrihvXZTj6Q9gF5xp089fSWUxshA3cHuEsHqd54UEzScdYOnB ZvBd8vvT/AySzHOkpwlVgHQmxYAF9RUrhDm27kWhGsQBCawSAYS6lwDQmnmE5wbQpkMI WLCGo3yHJ1xnm0vTLny3gVy0yr4u8ZC2Z3KVxYX+RPpENVZwa9EM+DtITkEAGj6+uKiO K4ruWuhu2Jl92Q9ZmzmOICzuhs8OLIbLtI2KEpkcToS98oIJtAwTDQr5e55x6jCpWuhk jI9g== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20240605; h=errors-to:content-transfer-encoding:list-subscribe:list-help :list-post:list-archive:list-unsubscribe:list-id:precedence:subject :mime-version:references:in-reply-to:message-id:date:to:from :dkim-signature:dkim-signature:dkim-signature; bh=GSOx4XipeVyxRk/I1KyUQJ5KEZ8rflwE228mxwoZqx4=; fh=4NbAC/LsuMLI0S0hprUlLSLCiHwg6SCAifhH718Jh0Q=; b=ef1Eo+XwjEP6IKpAlK5aN1pX8jj5Q5Gn1GmPWArJtzKPwQiC70bL+e0YAYHAbhrFLn J5xOwcjN4MkvgouzHj2WZrE8HQIBxwP4fwheQyMuQA0q6aKDF1hosb+sK20d4W8diHkq GsznDRl+U2IQR5VmGmBRwPvY0j8B6sJSQSmnyReX0tmqNaOy2qCDb4MYnI0bRTklYe9e Yab2HVe72JipaGxdNGu+yT0RMXy/Wx0RrvGHWFkGYTz+TlAH4rdI8Augay0rp+BOmSOt 6QuaxI7+sfawh59F/CT8WAK99JaKryLad9n58hCr/LrMt/CXtI01BjO96FBpKDKFqG5o t64g==; dara=google.com ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@lists.sourceforge.net header.s=beta header.b="Lo8eF/8x"; dkim=neutral (body hash did not verify) header.i=@sourceforge.net header.s=x header.b="P+cj/A2y"; dkim=neutral (body hash did not verify) header.i=@sf.net header.s=x header.b=kjh7h8Wk; spf=pass (google.com: domain of openvpn-devel-bounces@lists.sourceforge.net designates 216.105.38.7 as permitted sender) smtp.mailfrom=openvpn-devel-bounces@lists.sourceforge.net; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=muc.de Received: from lists.sourceforge.net (lists.sourceforge.net. [216.105.38.7]) by mx.google.com with ESMTPS id 5614622812f47-441989c0e81si2401036b6e.286.2025.10.13.09.04.02 (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Mon, 13 Oct 2025 09:04:02 -0700 (PDT) Received-SPF: pass (google.com: domain of openvpn-devel-bounces@lists.sourceforge.net designates 216.105.38.7 as permitted sender) client-ip=216.105.38.7; Authentication-Results: mx.google.com; dkim=pass header.i=@lists.sourceforge.net header.s=beta header.b="Lo8eF/8x"; dkim=neutral (body hash did not verify) header.i=@sourceforge.net header.s=x header.b="P+cj/A2y"; dkim=neutral (body hash did not verify) header.i=@sf.net header.s=x header.b=kjh7h8Wk; spf=pass (google.com: domain of openvpn-devel-bounces@lists.sourceforge.net designates 216.105.38.7 as permitted sender) smtp.mailfrom=openvpn-devel-bounces@lists.sourceforge.net; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=muc.de DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.sourceforge.net; s=beta; h=Content-Transfer-Encoding:Content-Type: List-Subscribe:List-Help:List-Post:List-Archive:List-Unsubscribe:List-Id: Subject:MIME-Version:References:In-Reply-To:Message-ID:Date:To:From:Sender: Reply-To:Cc:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Owner; bh=GSOx4XipeVyxRk/I1KyUQJ5KEZ8rflwE228mxwoZqx4=; b=Lo8eF/8xc546cRjynZqk5kPeE5 2nSxMsEImoNvtePGKolfp3nLgmEFN2T6IEVxloANKrBA5K8KpctlOSa6RbNPiJ2jAwzS0cGiM5b52 Ito8vUfikx7k1Ozq7oREp36RIb7+0Faq3Opp/fo01G1YJUibnypHHRTrnC+JkitRsmzs=; Received: from [127.0.0.1] (helo=sfs-ml-2.v29.lw.sourceforge.com) by sfs-ml-2.v29.lw.sourceforge.com with esmtp (Exim 4.95) (envelope-from ) id 1v8L1j-0003Cr-13; Mon, 13 Oct 2025 16:03:59 +0000 Received: from [172.30.29.66] (helo=mx.sourceforge.net) by sfs-ml-2.v29.lw.sourceforge.com with esmtps (TLS1.2) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.95) (envelope-from ) id 1v8L1i-0003Ci-DY for openvpn-devel@lists.sourceforge.net; Mon, 13 Oct 2025 16:03:59 +0000 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=sourceforge.net; s=x; h=Content-Transfer-Encoding:MIME-Version:References: In-Reply-To:Message-ID:Date:Subject:To:From:Sender:Reply-To:Cc:Content-Type: Content-ID:Content-Description:Resent-Date:Resent-From:Resent-Sender: Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help:List-Unsubscribe: List-Subscribe:List-Post:List-Owner:List-Archive; bh=eRshHBE/+w2XgxeGlzZ/9OrrY0vQ8NKZWCwvrumA1as=; b=P+cj/A2ymhyNPXj/I/+G3vVy5Y ERimtobWdxfrefHFpMGcKY4/S32qSjna/L+pgE7vM5+uA+CJ64Euese8/UoL5kTk74P6veT1ZkJfA OivwNQtmSB7wuEoeDjiAeUA1QVecK6k4VT0QanLdkPJO24IU+fRZaYml1dkSDUp8T8D8=; DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=sf.net; s=x ; h=Content-Transfer-Encoding:MIME-Version:References:In-Reply-To:Message-ID: Date:Subject:To:From:Sender:Reply-To:Cc:Content-Type:Content-ID: Content-Description:Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc :Resent-Message-ID:List-Id:List-Help:List-Unsubscribe:List-Subscribe: List-Post:List-Owner:List-Archive; bh=eRshHBE/+w2XgxeGlzZ/9OrrY0vQ8NKZWCwvrumA1as=; b=kjh7h8Wk7OftURU9li0IvNMXAK Mpa4tn5mNah6yG0iqI+3aYO2nCBCl0yySwArdtYFHgRkxqqlQaip65bA4Kv6AUqUbMq4FhpEBT+C0 K2K0vwwwYzG5gxAZ1Jw/FL7jAN++7WIfkqgdefu7TOuXll5RYk9OnW4Xlp+55yx3cloU=; Received: from [193.149.48.134] (helo=blue.greenie.muc.de) by sfi-mx-2.v28.lw.sourceforge.com with esmtps (TLS1.2:ECDHE-RSA-AES256-GCM-SHA384:256) (Exim 4.95) id 1v8L1i-0008QN-CN for openvpn-devel@lists.sourceforge.net; Mon, 13 Oct 2025 16:03:59 +0000 Received: from blue.greenie.muc.de (localhost [127.0.0.1]) by blue.greenie.muc.de (8.18.1/8.18.1) with ESMTP id 59DG3kUV032760 for ; Mon, 13 Oct 2025 18:03:46 +0200 Received: (from gert@localhost) by blue.greenie.muc.de (8.18.1/8.18.1/Submit) id 59DG3k7C032759 for openvpn-devel@lists.sourceforge.net; Mon, 13 Oct 2025 18:03:46 +0200 From: Gert Doering To: openvpn-devel@lists.sourceforge.net Date: Mon, 13 Oct 2025 18:03:39 +0200 Message-ID: <20251013160346.32741-1-gert@greenie.muc.de> X-Mailer: git-send-email 2.49.1 In-Reply-To: References: MIME-Version: 1.0 X-Spam-Score: 1.3 (+) X-Spam-Report: Spam detection software, running on the system "sfi-spamd-2.hosts.colo.sdot.me", has NOT identified this incoming email as spam. The original message has been attached to this so you can view it or label similar future email. If you have any questions, see the administrator of that system for details. Content preview: From: Frank Lichtenheld - uncrustify -> clang-format - add Gerrit - update Wiki links Change-Id: I77a59b9b74a13793782fbfbff6bd2ec581f86be0 Signed-off-by: Frank Lichtenheld Gerrit URL: https://gerrit.openvpn.net/c/openvpn/+/1271 --- Content analysis details: (1.3 points, 5.0 required) pts rule name description ---- ---------------------- -------------------------------------------------- 1.3 RDNS_NONE Delivered to internal network by a host with no rDNS X-Headers-End: 1v8L1i-0008QN-CN Subject: [Openvpn-devel] [PATCH v2] CONTRIBUTING: Update outdated/obsolete information X-BeenThere: openvpn-devel@lists.sourceforge.net X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: openvpn-devel-bounces@lists.sourceforge.net X-getmail-retrieved-from-mailbox: Inbox X-GMAIL-THRID: =?utf-8?q?1845883246230114335?= X-GMAIL-MSGID: =?utf-8?q?1845883246230114335?= From: Frank Lichtenheld - uncrustify -> clang-format - add Gerrit - update Wiki links Change-Id: I77a59b9b74a13793782fbfbff6bd2ec581f86be0 Signed-off-by: Frank Lichtenheld Gerrit URL: https://gerrit.openvpn.net/c/openvpn/+/1271 --- This change was reviewed on Gerrit and approved by at least one developer. I request to merge it to master. Gerrit URL: https://gerrit.openvpn.net/c/openvpn/+/1271 This mail reflects revision 2 of this Change. Acked-by according to Gerrit (reflected above): diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 67baa4e..bd76f7a 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -4,27 +4,32 @@ Patches should be written against the Git "master" branch. Some patches may get backported to a release branch. -The preferred procedure to send patches to the "openvpn-devel" mailing list: +The preferred procedure is to send patches to the "openvpn-devel" mailing list: - https://lists.sourceforge.net/lists/listinfo/openvpn-devel +Instead of directly sending patches to the list you can also create an account +in our instance of the Gerrit review tool: https://gerrit.openvpn.net/ +See https://community.openvpn.net/Development/GerritBestPractices. + While we do not merge GitHub pull requests as-is, we do allow their use for code review purposes. After the patch has been ACKed (reviewed and accepted), it must be sent to the mailing list. This last step does not necessarily need to be done by the patch author, although that is definitely recommended. When sending patches to "openvpn-devel" the subject line should be prefixed with -[PATCH]. To avoid merging issues the patches should be generated with +``[PATCH]``. To avoid merging issues the patches should be generated with git-format-patch or sent using git-send-email. Try to split large patches into small, atomic pieces to make reviews easier. Please make sure that the source code formatting follows the guidelines at -https://community.openvpn.net/openvpn/wiki/CodeStyle. Automated checking can be -done with uncrustify (https://uncrustify.sourceforge.net/) and the configuration -file which can be found in the git repository at dev-tools/uncrustify.conf. -There is also a git pre-commit hook script, which runs uncrustify automatically +https://community.openvpn.net/Development/CodeStyle. Automated checking can be +done with clang-format (https://community.openvpn.net/Development/CodeStyle) +and the configuration file which can be found in the git repository at ``.clang-format``. + +There is also a git pre-commit hook script, which runs clang-format automatically each time you commit and lets you format your code conveniently, if needed. -To install the hook simply run: dev-tools/git-pre-commit-uncrustify.sh install +To install the hook simply run: ``dev-tools/git-pre-commit-format.sh install`` If you want quick feedback on a patch before sending it to openvpn-devel mailing list, you can visit the #openvpn-devel channel on irc.libera.chat. Note that @@ -34,7 +39,7 @@ More detailed contribution instructions are available here: -- https://community.openvpn.net/openvpn/wiki/DeveloperDocumentation +- https://community.openvpn.net/Development/DeveloperDocumentation Note that the process for contributing to other OpenVPN projects such as openvpn-build, openvpn-gui, tap-windows6 and easy-rsa may differ from what was