From patchwork Mon Mar 9 02:17:19 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Simon Rozman X-Patchwork-Id: 1021 Return-Path: Delivered-To: patchwork@openvpn.net Delivered-To: patchwork@openvpn.net Received: from director9.mail.ord1d.rsapps.net ([172.30.191.6]) by backend30.mail.ord1d.rsapps.net with LMTP id kEvxHkNCZl4SagAAIUCqbw for ; Mon, 09 Mar 2020 09:18:59 -0400 Received: from proxy4.mail.ord1d.rsapps.net ([172.30.191.6]) by director9.mail.ord1d.rsapps.net with LMTP id ECHEHkNCZl51VAAAalYnBA ; Mon, 09 Mar 2020 09:18:59 -0400 Received: from smtp10.gate.ord1d ([172.30.191.6]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) by proxy4.mail.ord1d.rsapps.net with LMTP id 6AwGHkNCZl7TTgAAiYrejw ; Mon, 09 Mar 2020 09:18:59 -0400 X-Spam-Threshold: 95 X-Spam-Score: 0 X-Spam-Flag: NO X-Virus-Scanned: OK X-Orig-To: openvpnslackdevel@openvpn.net X-Originating-Ip: [216.105.38.7] Authentication-Results: smtp10.gate.ord1d.rsapps.net; iprev=pass policy.iprev="216.105.38.7"; spf=pass smtp.mailfrom="openvpn-devel-bounces@lists.sourceforge.net" smtp.helo="lists.sourceforge.net"; dkim=fail (signature verification failed) header.d=sourceforge.net; dkim=fail (signature verification failed) header.d=sf.net; dkim=fail (signature verification failed) header.d=rozman.si; dmarc=fail (p=none; dis=none) header.from=rozman.si X-Suspicious-Flag: YES X-Classification-ID: 88a34b14-6208-11ea-b5e7-52540013bccb-1-1 Received: from [216.105.38.7] ([216.105.38.7:49112] helo=lists.sourceforge.net) by smtp10.gate.ord1d.rsapps.net (envelope-from ) (ecelerity 4.2.38.62370 r(:)) with ESMTPS (cipher=DHE-RSA-AES256-GCM-SHA384) id F6/FD-18907-242466E5; Mon, 09 Mar 2020 09:18:58 -0400 Received: from [127.0.0.1] (helo=sfs-ml-4.v29.lw.sourceforge.com) by sfs-ml-4.v29.lw.sourceforge.com with esmtp (Exim 4.90_1) (envelope-from ) id 1jBIIT-000290-Gw; Mon, 09 Mar 2020 13:18:17 +0000 Received: from [172.30.20.202] (helo=mx.sourceforge.net) by sfs-ml-4.v29.lw.sourceforge.com with esmtps (TLSv1.2:ECDHE-RSA-AES256-GCM-SHA384:256) (Exim 4.90_1) (envelope-from ) id 1jBIIQ-00028U-OS for openvpn-devel@lists.sourceforge.net; Mon, 09 Mar 2020 13:18:14 +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:Cc:To:From:Sender:Reply-To: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=dTX8U/YJLEYJ55FCghepX0XR3yPMcYLJUacJlJcaiZI=; b=Qc2xRX4FcCGOV7NkN2bZEuDlyd YmPFSLaYux2wrj5B1XMAgAh6mRnB1zlxHKu8ALCBZlkuGVxQT/DRW5Ht/CM7ujjhe715RcObX7ZzZ +/v6rGWa6tujFPbsNgGVuHyvOfcmTqlRIOck96ZnaMESaTyENz+mO7IiI0thxEz1lp30=; 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:Cc:To:From:Sender:Reply-To: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=dTX8U/YJLEYJ55FCghepX0XR3yPMcYLJUacJlJcaiZI=; b=NvO1JfWTCVK+DpQ7E0fg1nYUO4 3Ei1z4xH8vRbb5n+tAvhgvLqf8anso93+miZ6tIZIYJpWVze/GrG4J64+KvI0W99ioMJSR94DsT42 RXW9+n/YlyT5izxhs1PFy20xqEYP1DvsJ1pny95WrplLHeBx3Z4LMYRV4Oyrn+EuZOok=; Received: from pub5.amebis.si ([213.250.55.21]) by sfi-mx-1.v28.lw.sourceforge.com with esmtps (TLSv1.2:ECDHE-RSA-AES256-GCM-SHA384:256) (Exim 4.92.2) id 1jBIIL-00DVnm-5r for openvpn-devel@lists.sourceforge.net; Mon, 09 Mar 2020 13:18:14 +0000 Received: by pub5.amebis.si (Postfix, from userid 1000) id 4BE201002FB5; Mon, 9 Mar 2020 14:17:55 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=rozman.si; s=default; t=1583759875; bh=dTX8U/YJLEYJ55FCghepX0XR3yPMcYLJUacJlJcaiZI=; h=From:To:Cc:Subject:Date:In-Reply-To:References:From; b=o1nSmk/+cuO5xm0owapk9resS3v+izuz8rusMuZo5Wsb8SROX6c4N6STtZkL82kes 2b9sdOSPdb/HEBJcGFpLYrPpDHop5COJxajAopFYJkTpb6kAJkzHt9J+TqEqQrzI/A IxhqhpJeg0PWhtb5Cleqvi0F9f27oMEMYWHs58uo= X-Spam-Checker-Version: SpamAssassin 3.4.3 (2019-12-06) on brana.amebis.doma X-Spam-Level: X-Spam-Status: No, score=-2.9 required=5.0 tests=ALL_TRUSTED,BAYES_00 autolearn=unavailable autolearn_force=no version=3.4.3 Received: from SR6.amebis.doma (unknown [IPv6:2a00:ee2:209:164:a5ae:e83c:b7b:725]) by pub5.amebis.si (Postfix) with ESMTP id EDAF11002FB5; Mon, 9 Mar 2020 14:17:48 +0100 (CET) From: Simon Rozman To: openvpn-devel@lists.sourceforge.net Date: Mon, 9 Mar 2020 14:17:19 +0100 Message-Id: <20200309131728.380-3-simon@rozman.si> X-Mailer: git-send-email 2.24.1.windows.2 In-Reply-To: <20200309131728.380-1-simon@rozman.si> References: <20200309131728.380-1-simon@rozman.si> MIME-Version: 1.0 X-Spam-Report: Spam Filtering performed by mx.sourceforge.net. See http://spamassassin.org/tag/ for more details. -0.0 SPF_PASS SPF: sender matches SPF record 0.0 SPF_HELO_NONE SPF: HELO does not publish an SPF Record -0.1 DKIM_VALID_AU Message has a valid DKIM or DK signature from author's domain -0.1 DKIM_VALID Message has at least one valid DKIM or DK signature 0.1 DKIM_SIGNED Message has a DKIM or DK signature, not necessarily valid X-Headers-End: 1jBIIL-00DVnm-5r Subject: [Openvpn-devel] [PATCH 03/12] tapctl: Update documentation 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 Signed-off-by: Simon Rozman Acked-by: Gert Doering --- src/tapctl/tap.c | 17 ++++++++--------- src/tapctl/tap.h | 18 +++++++++--------- 2 files changed, 17 insertions(+), 18 deletions(-) diff --git a/src/tapctl/tap.c b/src/tapctl/tap.c index 464ce725..b8249919 100644 --- a/src/tapctl/tap.c +++ b/src/tapctl/tap.c @@ -2,7 +2,7 @@ * tapctl -- Utility to manipulate TUN/TAP interfaces on Windows * https://community.openvpn.net/openvpn/wiki/Tapctl * - * Copyright (C) 2018 Simon Rozman + * Copyright (C) 2018-2020 Simon Rozman * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License version 2 @@ -51,15 +51,15 @@ const static TCHAR szInterfaceRegKeyPathTemplate[] = TEXT("SYSTEM\\CurrentContro * Checks device install parameters if a system reboot is required. * * @param hDeviceInfoSet A handle to a device information set that contains a device - * information element that represents the device for which to + * information element that represents the device. * * @param pDeviceInfoData A pointer to an SP_DEVINFO_DATA structure that specifies the * device information element in hDeviceInfoSet. * - * @param pbRebootRequired A pointer to a BOOL flag. If the interface installation requires - * a system restart, this flag is set to TRUE. Otherwise, the flag is - * left unmodified. This allows the flag to be globally initialized to - * FALSE and reused for multiple interface installations. + * @param pbRebootRequired A pointer to a BOOL flag. If the device requires a system restart, + * this flag is set to TRUE. Otherwise, the flag is left unmodified. This + * allows the flag to be globally initialized to FALSE and reused for multiple + * interface manipulations. * * @return ERROR_SUCCESS on success; Win32 error code otherwise **/ @@ -244,7 +244,7 @@ get_reg_string( * Returns network interface ID. * * @param hDeviceInfoSet A handle to a device information set that contains a device - * information element that represents the device for which to + * information element that represents the device. * * @param pDeviceInfoData A pointer to an SP_DEVINFO_DATA structure that specifies the * device information element in hDeviceInfoSet. @@ -330,8 +330,7 @@ get_net_interface_guid( * Returns a specified Plug and Play device property. * * @param hDeviceInfoSet A handle to a device information set that contains a device - * information element that represents the device for which to - * retrieve a Plug and Play property. + * information element that represents the device. * * @param pDeviceInfoData A pointer to an SP_DEVINFO_DATA structure that specifies the * device information element in hDeviceInfoSet. diff --git a/src/tapctl/tap.h b/src/tapctl/tap.h index f74a39df..ca66e5da 100644 --- a/src/tapctl/tap.h +++ b/src/tapctl/tap.h @@ -2,7 +2,7 @@ * tapctl -- Utility to manipulate TUN/TAP interfaces on Windows * https://community.openvpn.net/openvpn/wiki/Tapctl * - * Copyright (C) 2018 Simon Rozman + * Copyright (C) 2018-2020 Simon Rozman * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License version 2 @@ -41,10 +41,10 @@ * of the device. This pointer is optional and can be NULL. Default value * is root\tap0901. * - * @param pbRebootRequired A pointer to a BOOL flag. If the interface installation requires - * a system restart, this flag is set to TRUE. Otherwise, the flag is - * left unmodified. This allows the flag to be globally initialized to - * FALSE and reused for multiple interface installations. + * @param pbRebootRequired A pointer to a BOOL flag. If the device requires a system restart, + * this flag is set to TRUE. Otherwise, the flag is left unmodified. This + * allows the flag to be globally initialized to FALSE and reused for multiple + * interface manipulations. * * @param pguidInterface A pointer to GUID that receives network interface ID. * @@ -70,10 +70,10 @@ tap_create_interface( * * @param pguidInterface A pointer to GUID that contains network interface ID. * - * @param pbRebootRequired A pointer to a BOOL flag. If the interface installation requires - * a system restart, this flag is set to TRUE. Otherwise, the flag is - * left unmodified. This allows the flag to be globally initialized to - * FALSE and reused for multiple interface installations. + * @param pbRebootRequired A pointer to a BOOL flag. If the device requires a system restart, + * this flag is set to TRUE. Otherwise, the flag is left unmodified. This + * allows the flag to be globally initialized to FALSE and reused for multiple + * interface manipulations. * * @return ERROR_SUCCESS on success; Win32 error code otherwise **/