Re: svn commit: r1915387 - /httpd/httpd/trunk/README

[Stefan Eissing via dev]

Thanks!

> Am 24.01.2024 um 22:33 schrieb rbo...@apache.org:
> 
> Author: rbowen
> Date: Wed Jan 24 21:33:30 2024
> New Revision: 1915387
> 
> URL: http://svn.apache.org/viewvc?rev=1915387&view=rev
> Log:
> Converts README to markdown (no textual changes) for better display on
> Github.
> 
> Submitted by: Mayank Patil (mayank-2...@users.noreply.github.com)
> 
> Patch modified to preserve original linebreaks.
> 
> Github: closes #363
> 
> Modified:
>httpd/httpd/trunk/README
> 
> Modified: httpd/httpd/trunk/README
> URL: 
> http://svn.apache.org/viewvc/httpd/httpd/trunk/README?rev=1915387&r1=1915386&r2=1915387&view=diff
> ==
> --- httpd/httpd/trunk/README (original)
> +++ httpd/httpd/trunk/README Wed Jan 24 21:33:30 2024
> @@ -1,110 +1,106 @@
> 
> -  Apache HTTP Server
> +# Apache HTTP Server
> 
> -  What is it?
> -  ---
> +##  What is it?
> 
> -  The Apache HTTP Server is a powerful and flexible HTTP/1.1 compliant
> -  web server.  Originally designed as a replacement for the NCSA HTTP
> -  Server, it has grown to be the most popular web server on the
> -  Internet.  As a project of the Apache Software Foundation, the
> -  developers aim to collaboratively develop and maintain a robust,
> -  commercial-grade, standards-based server with freely available
> -  source code.
> -
> -  The Latest Version
> -  --
> -
> -  Details of the latest version can be found on the Apache HTTP
> -  server project page under https://httpd.apache.org/.
> -
> -  Documentation
> -  -
> -
> -  The documentation available as of the date of this release is
> -  included in HTML format in the docs/manual/ directory.  The most
> -  up-to-date documentation can be found at
> -  https://httpd.apache.org/docs/trunk/.
> -
> -  Installation
> -  
> -
> -  Please see the file called INSTALL.  Platform specific notes can be
> -  found in README.platforms.
> -
> -  Licensing
> -  -
> -
> -  Please see the file called LICENSE.
> -
> -  Cryptographic Software Notice
> -  -
> -
> -  This distribution may include software that has been designed for use
> -  with cryptographic software.  The country in which you currently reside
> -  may have restrictions on the import, possession, use, and/or re-export
> -  to another country, of encryption software.  BEFORE using any encryption
> -  software, please check your country's laws, regulations and policies
> -  concerning the import, possession, or use, and re-export of encryption
> -  software, to see if this is permitted.  See 
> -  for more information.
> -
> -  The U.S. Government Department of Commerce, Bureau of Industry and
> -  Security (BIS), has classified this software as Export Commodity 
> -  Control Number (ECCN) 5D002.C.1, which includes information security
> -  software using or performing cryptographic functions with asymmetric
> -  algorithms.  The form and manner of this Apache Software Foundation
> -  distribution makes it eligible for export under the License Exception
> -  ENC Technology Software Unrestricted (TSU) exception (see the BIS 
> -  Export Administration Regulations, Section 740.13) for both object 
> -  code and source code.
> -
> -  The following provides more details on the included files that
> -  may be subject to export controls on cryptographic software:
> -
> -Apache httpd 2.0 and later versions include the mod_ssl module under
> -   modules/ssl/
> -for configuring and listening to connections over SSL encrypted
> -network sockets by performing calls to a general-purpose encryption
> -library, such as OpenSSL or the operating system's platform-specific
> -SSL facilities.
> -
> -In addition, some versions of apr-util provide an abstract interface
> -for symmetrical cryptographic functions that make use of a
> -general-purpose encryption library, such as OpenSSL, NSS, or the
> -operating system's platform-specific facilities. This interface is
> -known as the apr_crypto interface, with implementation beneath the
> -/crypto directory. The apr_crypto interface is used by the
> -mod_session_crypto module available under
> -  modules/session
> -for optional encryption of session information.
> -
> -Some object code distributions of Apache httpd, indicated with the
> -word "crypto" in the package name, may include object code for the
> -OpenSSL encryption library as distributed in open source form from
> -.
> -
> -  The above files are optional and may be removed if the cryptographic
> -  functionality is not desired or needs to be excluded from redistribution.
> -  Distribution packages of Apache httpd that include the word "nossl"
> -  in the package name have been created without the above files and are
> -  therefore not subject to this notice

Re: PR #363

[Ruediger Pluem]

On 1/25/24 8:04 AM, Ruediger Pluem wrote:
> 
> 
> On 1/24/24 11:31 PM, Rich Bowen wrote:
>> Well, it turns out that in order for this to actually work, we would need to 
>> rename README to README.md, so I'm inclined to revert
>> this change unless someone thinks differently.
> 
> How about using a symlink? Keep README and create a README.md symlink to it?
> But I am not sure if github handles this correctly.

Tried it in r1915391 and it seems to work. Not sure if there are general 
downsides / objections with regards to symlinks in our
repository. But trunk is CTR :-).

Regards

Rüdiger

Re: PR #363

[Ruediger Pluem]

On 1/24/24 11:31 PM, Rich Bowen wrote:
> Well, it turns out that in order for this to actually work, we would need to 
> rename README to README.md, so I'm inclined to revert
> this change unless someone thinks differently.

How about using a symlink? Keep README and create a README.md symlink to it?
But I am not sure if github handles this correctly.

Regards

Rüdiger

Re: PR #363

[Rich Bowen]

Well, it turns out that in order for this to actually work, we would need
to rename README to README.md, so I'm inclined to revert this change unless
someone thinks differently.

Rich

On Wed, Jan 24, 2024, 10:06  wrote:

> I've been poking at some of our open PRs looking for docs-only changes
> that we can possibly clean up.
>
> PR #363 - https://github.com/apache/httpd/pull/363 - converts README
> from plaintext to markdown, and makes no other changes. This makes it
> prettier on GitHub.
>
> I almost just CTR'ed it, but it occurred to me that someone might find
> this objectionable, so I thought I'd ask first.
>

Re: PR #363

[Yann Ylavic]

On Wed, Jan 24, 2024 at 5:07 PM  wrote:
>
> On Wed, 2024-01-24 at 17:01 +0100, Yann Ylavic wrote:
> > On Wed, Jan 24, 2024 at 4:56 PM Mads Toftum  wrote:
> > >
> > > On Wed, Jan 24, 2024 at 10:06:43AM -0500, rbo...@rcbowen.com wrote:
> > > > I've been poking at some of our open PRs looking for docs-only
> > > > changes
> > > > that we can possibly clean up.
> > > >
> > > > PR #363 - https://github.com/apache/httpd/pull/363 - converts
> > > > README
> > > > from plaintext to markdown, and makes no other changes. This
> > > > makes it
> > > > prettier on GitHub.
> > > >
> > > > I almost just CTR'ed it, but it occurred to me that someone might
> > > > find
> > > > this objectionable, so I thought I'd ask first.
> > >
> > > I don't have strong opinions on this, but we'll end up with a
> > > READNE
> > > that's less readable for those not viewing it through github.
> >
> > Maybe we could keep the line breaks as before for the text to keep it
> > as readable as before w/o a markdown viewer?
>
> Yeah, I've done that in my local copy of the patch.
>
> So this is basically changing:
>
> Whossname
> -
>
> to
>
> ## Whossname
>
> Which really doesn't change much in plain text mode.

Agreed, the main readability issue (in plain text mode) is long lines
IMHO, headings/links do not read so bad.

Re: PR #363

[rbowen]

On Wed, 2024-01-24 at 17:01 +0100, Yann Ylavic wrote:
> On Wed, Jan 24, 2024 at 4:56 PM Mads Toftum  wrote:
> > 
> > On Wed, Jan 24, 2024 at 10:06:43AM -0500, rbo...@rcbowen.com wrote:
> > > I've been poking at some of our open PRs looking for docs-only
> > > changes
> > > that we can possibly clean up.
> > > 
> > > PR #363 - https://github.com/apache/httpd/pull/363 - converts
> > > README
> > > from plaintext to markdown, and makes no other changes. This
> > > makes it
> > > prettier on GitHub.
> > > 
> > > I almost just CTR'ed it, but it occurred to me that someone might
> > > find
> > > this objectionable, so I thought I'd ask first.
> > 
> > I don't have strong opinions on this, but we'll end up with a
> > READNE
> > that's less readable for those not viewing it through github.
> 
> Maybe we could keep the line breaks as before for the text to keep it
> as readable as before w/o a markdown viewer?

Yeah, I've done that in my local copy of the patch.

So this is basically changing:

Whossname
-

to

## Whossname

Which really doesn't change much in plain text mode.

Re: PR #363

[Joe Schaefer]

With GFM, each line break separates paragraphs.

Joe Schaefer, Ph.D.

Orion - The Enterprise Jamstack Wiki 

954.253.3732 




On Wed, Jan 24, 2024 at 11:01 AM Yann Ylavic  wrote:

> On Wed, Jan 24, 2024 at 4:56 PM Mads Toftum  wrote:
> >
> > On Wed, Jan 24, 2024 at 10:06:43AM -0500, rbo...@rcbowen.com wrote:
> > > I've been poking at some of our open PRs looking for docs-only changes
> > > that we can possibly clean up.
> > >
> > > PR #363 - https://github.com/apache/httpd/pull/363 - converts README
> > > from plaintext to markdown, and makes no other changes. This makes it
> > > prettier on GitHub.
> > >
> > > I almost just CTR'ed it, but it occurred to me that someone might find
> > > this objectionable, so I thought I'd ask first.
> >
> > I don't have strong opinions on this, but we'll end up with a READNE
> > that's less readable for those not viewing it through github.
>
> Maybe we could keep the line breaks as before for the text to keep it
> as readable as before w/o a markdown viewer?
>
>
> Regards;
> Yann.
>

Re: PR #363

[Yann Ylavic]

On Wed, Jan 24, 2024 at 4:56 PM Mads Toftum  wrote:
>
> On Wed, Jan 24, 2024 at 10:06:43AM -0500, rbo...@rcbowen.com wrote:
> > I've been poking at some of our open PRs looking for docs-only changes
> > that we can possibly clean up.
> >
> > PR #363 - https://github.com/apache/httpd/pull/363 - converts README
> > from plaintext to markdown, and makes no other changes. This makes it
> > prettier on GitHub.
> >
> > I almost just CTR'ed it, but it occurred to me that someone might find
> > this objectionable, so I thought I'd ask first.
>
> I don't have strong opinions on this, but we'll end up with a READNE
> that's less readable for those not viewing it through github.

Maybe we could keep the line breaks as before for the text to keep it
as readable as before w/o a markdown viewer?


Regards;
Yann.

Re: PR #363

[Mads Toftum]

On Wed, Jan 24, 2024 at 10:06:43AM -0500, rbo...@rcbowen.com wrote:
> I've been poking at some of our open PRs looking for docs-only changes
> that we can possibly clean up.
> 
> PR #363 - https://github.com/apache/httpd/pull/363 - converts README
> from plaintext to markdown, and makes no other changes. This makes it
> prettier on GitHub.
> 
> I almost just CTR'ed it, but it occurred to me that someone might find
> this objectionable, so I thought I'd ask first.

I don't have strong opinions on this, but we'll end up with a READNE
that's less readable for those not viewing it through github.

vh

Mads Toftum
-- 
http://flickr.com/photos/q42/

PR #363

[rbowen]

I've been poking at some of our open PRs looking for docs-only changes
that we can possibly clean up.

PR #363 - https://github.com/apache/httpd/pull/363 - converts README
from plaintext to markdown, and makes no other changes. This makes it
prettier on GitHub.

I almost just CTR'ed it, but it occurred to me that someone might find
this objectionable, so I thought I'd ask first.