[PATCH] cygwin: doc: Add keywords for ACE order issues

classic Classic list List threaded Threaded
5 messages Options
Reply | Threaded
Open this post in threaded view
|

[PATCH] cygwin: doc: Add keywords for ACE order issues

cygwin-patches mailing list
Windows Explorer shows a warning with Cygwin-created DACLs, but putting
the text of the warning into Google doesn't lead to the relevant Cygwin
docs.  Let's copy the warning text into the docs in the hopes of helping
confused users.

Latest inquiry: <https://cygwin.com/pipermail/cygwin/2020-May/244814.html>

Signed-off-by: David Macek <[hidden email]>
---
 winsup/doc/ntsec.xml | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/winsup/doc/ntsec.xml b/winsup/doc/ntsec.xml
index 08a33bdc6c..b94cdd9a97 100644
--- a/winsup/doc/ntsec.xml
+++ b/winsup/doc/ntsec.xml
@@ -2163,7 +2163,10 @@ preferred order.</para>
 the Windows Explorer insists to rearrange the order of the ACEs to
 canonical order before you can read them. Thank God, the sort order
 remains unchanged if one presses the Cancel button.  But don't even
-<emphasis role='bold'>think</emphasis> of pressing OK...</para>
+<emphasis role='bold'>think</emphasis> of pressing OK...  For the sake
+of people searching for this explanation, let's note that the Explorer
+warning says "The permissions on ... are incorrectly orderer, which may
+cause some entries to be ineffective."</para>
 
 <para>Canonical ACLs are unable to reflect each possible combination
 of POSIX permissions. Example:</para>
--
2.26.2.windows.1

Reply | Threaded
Open this post in threaded view
|

Re: [PATCH] cygwin: doc: Add keywords for ACE order issues

cygwin-patches mailing list
> +warning says "The permissions on ... are incorrectly orderer, which may

Oof. Please fix "orderer" to "ordered" if accepted.

--
David Macek
Reply | Threaded
Open this post in threaded view
|

Re: [PATCH] cygwin: doc: Add keywords for ACE order issues

cygwin-patches mailing list
In reply to this post by cygwin-patches mailing list
On Tue, 2020-05-12 at 22:49 +0200, David Macek via Cygwin-patches
wrote:

> Windows Explorer shows a warning with Cygwin-created DACLs, but putting
> the text of the warning into Google doesn't lead to the relevant Cygwin
> docs.  Let's copy the warning text into the docs in the hopes of helping
> confused users.
>
> Latest inquiry: <https://cygwin.com/pipermail/cygwin/2020-May/244814.html>
>
> Signed-off-by: David Macek <[hidden email]>
> ---
>  winsup/doc/ntsec.xml | 5 ++++-
>  1 file changed, 4 insertions(+), 1 deletion(-)
>
> diff --git a/winsup/doc/ntsec.xml b/winsup/doc/ntsec.xml
> index 08a33bdc6c..b94cdd9a97 100644
> --- a/winsup/doc/ntsec.xml
> +++ b/winsup/doc/ntsec.xml
> @@ -2163,7 +2163,10 @@ preferred order.</para>
>  the Windows Explorer insists to rearrange the order of the ACEs to
>  canonical order before you can read them. Thank God, the sort order
>  remains unchanged if one presses the Cancel button.  But don't even
> -<emphasis role='bold'>think</emphasis> of pressing OK...</para>
> +<emphasis role='bold'>think</emphasis> of pressing OK...  For the sake
> +of people searching for this explanation, let's note that the Explorer
> +warning says "The permissions on ... are incorrectly orderer, which may
> +cause some entries to be ineffective."</para>
>  
>  <para>Canonical ACLs are unable to reflect each possible combination
>  of POSIX permissions. Example:</para>

The wording seems awkward.  Why not quote the text of the warning
directly earlier in the paragraph, e.g.:

<para>Unfortunately, the security tab in the file properties dialog of
the Windows Explorer will pop up a warning stating: "The permissions on
... are incorrectly ordered, which may cause some entries to be
ineffective."  Pressing the Cancel button will leave the order
unchanged, but pressing OK will cause Windows to canonicalize the order
of the ACEs, thereby invalidating POSIX compatibility.</para>

--
Yaakov Selkowitz
Senior Software Engineer - Platform Enablement
Red Hat, Inc.


Reply | Threaded
Open this post in threaded view
|

[PATCH v2] cygwin: doc: Add keywords for ACE order issues

cygwin-patches mailing list
Windows Explorer shows a warning with Cygwin-created DACLs, but putting
the text of the warning into Google doesn't lead to the relevant Cygwin
docs.  Let's copy the warning text into the docs in the hopes of helping
confused users.  Most of the credit for the wording belongs to Yaakov
Selkowitz.

Latest inquiry: <https://cygwin.com/pipermail/cygwin/2020-May/244814.html>

Signed-off-by: David Macek <[hidden email]>
---

I thought about the wording and there was one one advantage of the
clumsy variant -- anyone intending to modify the paragraph would
immediately know why the full message is there (in my opinion it
doesn't add much value for the reader).  In any case, here's the
variant with nicer wording (which I also like better).

 winsup/doc/ntsec.xml | 12 +++++++-----
 1 file changed, 7 insertions(+), 5 deletions(-)

diff --git a/winsup/doc/ntsec.xml b/winsup/doc/ntsec.xml
index 08a33bdc6c..8644965349 100644
--- a/winsup/doc/ntsec.xml
+++ b/winsup/doc/ntsec.xml
@@ -2159,11 +2159,13 @@ will correctly deal with the ACL regardless of the order of allow and
 deny ACEs.  The second rule is not modified to get the ACEs in the
 preferred order.</para>
 
-<para>Unfortunately the security tab in the file properties dialog of
-the Windows Explorer insists to rearrange the order of the ACEs to
-canonical order before you can read them. Thank God, the sort order
-remains unchanged if one presses the Cancel button.  But don't even
-<emphasis role='bold'>think</emphasis> of pressing OK...</para>
+<para>Unfortunately, the security tab in the file properties dialog of
+the Windows Explorer will pop up a warning stating "The permissions on
+... are incorrectly ordered, which may cause some entries to be
+ineffective."  Pressing the Cancel button of the properties dialog
+fortunately leaves the sort order unchanged, but pressing OK will cause
+Explorer to canonicalize the order of the ACEs, thereby invalidating
+POSIX compatibility.</para>
 
 <para>Canonical ACLs are unable to reflect each possible combination
 of POSIX permissions. Example:</para>
--
2.26.2.windows.1

Reply | Threaded
Open this post in threaded view
|

Re: [PATCH v2] cygwin: doc: Add keywords for ACE order issues

Corinna Vinschen-2
On May 13 17:34, David Macek via Cygwin-patches wrote:

> Windows Explorer shows a warning with Cygwin-created DACLs, but putting
> the text of the warning into Google doesn't lead to the relevant Cygwin
> docs.  Let's copy the warning text into the docs in the hopes of helping
> confused users.  Most of the credit for the wording belongs to Yaakov
> Selkowitz.
>
> Latest inquiry: <https://cygwin.com/pipermail/cygwin/2020-May/244814.html>
>
> Signed-off-by: David Macek <[hidden email]>
> ---

Pushed.


Thanks,
Corinna

--
Corinna Vinschen
Cygwin Maintainer