Proposed improvement to :help 'directory'

[Gary Johnson]

The help entry for 'directory' doesn't say anything about the colon
following the drive letter in the swap file name being replaced by
a percent sign.

I propose that the sentence describing the swap file name
construction be changed from

- For Unix and Win32, if a directory ends in two path separators "//",
the swap file name will be built from the complete path to the file
with all path separators substituted to percent '%' signs.

to

- For Unix and Win32, if a directory ends in two path separators "//",
the swap file name will be built from the complete path to the file
with the colon following the drive letter on Win32 and all path
separators replaced by percent '%' signs.

I also improved the grammar. A patch based on 8.2.1462 is attached.

Regards,
Gary

[Bram Moolenaar]

Thanks. Starting the sentence mentioning the colon for Win32 makes it a
bit long. Since the colon is a specific instance of the path separator,
I think it reads a bit easier like this:

- For Unix and Win32, if a directory ends in two path separators "//",
the swap file name will be built from the complete path to the file

with all path separators replaced by percent '%' signs (including
the colon following the drive letter on Win32). This will ensure
file name uniqueness in the preserve directory.


--
hundred-and-one symptoms of being an internet addict:
216. Your pet rock leaves home.

/// Bram Moolenaar -- Br...@Moolenaar.net -- http://www.Moolenaar.net \\\
/// sponsor Vim, vote for features -- http://www.Vim.org/sponsor/ \\\
\\\ an exciting new programming language -- http://www.Zimbu.org ///
\\\ help me help AIDS victims -- http://ICCF-Holland.org ///

[Gary Johnson]

On 2020-08-15, Bram Moolenaar wrote:
> Gary Johnson wrote:
>
> > The help entry for 'directory' doesn't say anything about the colon
> > following the drive letter in the swap file name being replaced by
> > a percent sign.
> >
> > I propose that the sentence describing the swap file name
> > construction be changed from
> >
> > - For Unix and Win32, if a directory ends in two path separators "//",
> > the swap file name will be built from the complete path to the file
> > with all path separators substituted to percent '%' signs.
> >
> > to
> >
> > - For Unix and Win32, if a directory ends in two path separators "//",
> > the swap file name will be built from the complete path to the file
> > with the colon following the drive letter on Win32 and all path
> > separators replaced by percent '%' signs.
> >
> > I also improved the grammar. A patch based on 8.2.1462 is attached.
>
> Thanks. Starting the sentence mentioning the colon for Win32 makes it a
> bit long. Since the colon is a specific instance of the path separator,
> I think it reads a bit easier like this:
>
> - For Unix and Win32, if a directory ends in two path separators "//",
> the swap file name will be built from the complete path to the file
> with all path separators replaced by percent '%' signs (including
> the colon following the drive letter on Win32). This will ensure
> file name uniqueness in the preserve directory.

That works.

Regards,
Gary