You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@hc.apache.org by GitBox <gi...@apache.org> on 2020/12/23 18:10:07 UTC
[GitHub] [httpcomponents-client] Marcono1234 opened a new pull request #273: Convert README to markdown
Marcono1234 opened a new pull request #273:
URL: https://github.com/apache/httpcomponents-client/pull/273
Notable changes:
- Link to BUILDILNG, LICENSE and NOTICE
- Move "Contact" section above "Cryptographic Software Notice" because it is likely more important for most users
- Use HTTPS links
Preview can be seen [here](https://github.com/Marcono1234/httpcomponents-client/blob/marcono1234/readme/README.md).
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
[GitHub] [httpcomponents-client] ok2c edited a comment on pull request #273: Convert README to markdown
Posted by GitBox <gi...@apache.org>.
ok2c edited a comment on pull request #273:
URL: https://github.com/apache/httpcomponents-client/pull/273#issuecomment-750560312
> Where does the text requirement come from? Markdown is so simple that most people can render it in their brain directly.
It is not a requirement but rather a tradition. If you think we should remove README.txt in favor of README.md I suppose I can live with that but we should be consistent and do it in HttpCore as well.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
[GitHub] [httpcomponents-client] ok2c merged pull request #273: Convert README to markdown
Posted by GitBox <gi...@apache.org>.
ok2c merged pull request #273:
URL: https://github.com/apache/httpcomponents-client/pull/273
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
[GitHub] [httpcomponents-client] garydgregory commented on pull request #273: Convert README to markdown
Posted by GitBox <gi...@apache.org>.
garydgregory commented on pull request #273:
URL: https://github.com/apache/httpcomponents-client/pull/273#issuecomment-750884067
> > @ok2c which license header should I use? HttpCore includes "Copyright (C) 2016 Gary Gregory", should I maybe instead use the one from pom.xml?
>
> That looks odd. @garydgregory, any idea why your name is README.md copyright header? Was that intentional?
>
> @Marcono1234 Please use the one from pom.xml
"Copyright (C) 2016 Gary Gregory"
That must be a mistake by me when adding a new file.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
[GitHub] [httpcomponents-client] ok2c commented on pull request #273: Convert README to markdown
Posted by GitBox <gi...@apache.org>.
ok2c commented on pull request #273:
URL: https://github.com/apache/httpcomponents-client/pull/273#issuecomment-750560312
> Where does the text requirement come from? Markdown is so simple that most people can render it in their brain directly.
It is not a requirement but rather a tradition. If you think we should remove README.txt in favor of README.md I suppose I can live with that but we should be consistent and do it HttpCore as well.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
[GitHub] [httpcomponents-client] michael-o commented on a change in pull request #273: Convert README to markdown
Posted by GitBox <gi...@apache.org>.
michael-o commented on a change in pull request #273:
URL: https://github.com/apache/httpcomponents-client/pull/273#discussion_r548312031
##########
File path: README.md
##########
@@ -3,30 +3,44 @@ Apache HttpComponents Client
Welcome to the HttpClient component of the Apache HttpComponents project.
+[](https://travis-ci.com/apache/httpcomponents-client)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.httpcomponents.client5/httpclient5)
+[](https://opensource.org/licenses/Apache-2.0)
+
Building Instructions
---------------------
-For building from source instructions please refer to BUILDING.txt.
+For building from source instructions please refer to [BUILDING.txt](./BUILDING.txt).
Dependencies
------------
HttpClient main module requires Java 7 compatible runtime and
depends on the following external libraries:
-* Apache HttpComponents HttpCore
-* Apache Logging Log4j2 API
-* Apache Commons Codec
+* [Apache HttpComponents HttpCore](https://github.com/apache/httpcomponents-core)
+* [Apache Logging Log4j2 API](https://github.com/apache/logging-log4j2)
Review comment:
I wonder where this comes from. Seems to be old. Can be dropped.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
[GitHub] [httpcomponents-client] michael-o commented on a change in pull request #273: Convert README to markdown
Posted by GitBox <gi...@apache.org>.
michael-o commented on a change in pull request #273:
URL: https://github.com/apache/httpcomponents-client/pull/273#discussion_r548318063
##########
File path: README.md
##########
@@ -3,30 +3,44 @@ Apache HttpComponents Client
Welcome to the HttpClient component of the Apache HttpComponents project.
+[](https://travis-ci.com/apache/httpcomponents-client)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.httpcomponents.client5/httpclient5)
+[](https://opensource.org/licenses/Apache-2.0)
+
Building Instructions
---------------------
-For building from source instructions please refer to BUILDING.txt.
+For building from source instructions please refer to [BUILDING.txt](./BUILDING.txt).
Dependencies
------------
HttpClient main module requires Java 7 compatible runtime and
depends on the following external libraries:
-* Apache HttpComponents HttpCore
-* Apache Logging Log4j2 API
-* Apache Commons Codec
+* [Apache HttpComponents HttpCore](https://github.com/apache/httpcomponents-core)
+* [Apache Logging Log4j2 API](https://github.com/apache/logging-log4j2)
Review comment:
These are correct now.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
[GitHub] [httpcomponents-client] michael-o commented on pull request #273: Convert README to markdown
Posted by GitBox <gi...@apache.org>.
michael-o commented on pull request #273:
URL: https://github.com/apache/httpcomponents-client/pull/273#issuecomment-750554115
>
>
> @Marcono1234 We need to keep README.txt because it gets shipped with release dist packages. README.md must have a ASLv2 header as in HttpCore. Looks good otherwise.
Where does the text requirement come from? Markdown is so simple that most people can render it in their brain directly.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
[GitHub] [httpcomponents-client] Marcono1234 commented on pull request #273: Convert README to markdown
Posted by GitBox <gi...@apache.org>.
Marcono1234 commented on pull request #273:
URL: https://github.com/apache/httpcomponents-client/pull/273#issuecomment-750608452
Force-pushed to include the license header in commit "Convert README to markdown".
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
[GitHub] [httpcomponents-client] ok2c commented on pull request #273: Convert README to markdown
Posted by GitBox <gi...@apache.org>.
ok2c commented on pull request #273:
URL: https://github.com/apache/httpcomponents-client/pull/273#issuecomment-750577690
> @ok2c which license header should I use? HttpCore includes "Copyright (C) 2016 Gary Gregory", should I maybe instead use the one from pom.xml?
That looks odd. @garydgregory, any idea why your name is README.md copyright header? Was that intentional?
@Marcono1234 Please use the one from pom.xml
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
[GitHub] [httpcomponents-client] Marcono1234 commented on pull request #273: Convert README to markdown
Posted by GitBox <gi...@apache.org>.
Marcono1234 commented on pull request #273:
URL: https://github.com/apache/httpcomponents-client/pull/273#issuecomment-750572369
@ok2c which license header should I use? HttpCore includes "Copyright (C) 2016 Gary Gregory", should I maybe instead use the one from pom.xml?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
[GitHub] [httpcomponents-client] garydgregory commented on pull request #273: Convert README to markdown
Posted by GitBox <gi...@apache.org>.
garydgregory commented on pull request #273:
URL: https://github.com/apache/httpcomponents-client/pull/273#issuecomment-750884475
FWIW, we use readme in markdown in all or most Apache Commons components.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
[GitHub] [httpcomponents-client] michael-o commented on pull request #273: Convert README to markdown
Posted by GitBox <gi...@apache.org>.
michael-o commented on pull request #273:
URL: https://github.com/apache/httpcomponents-client/pull/273#issuecomment-750884990
>
>
> FWIW, we use readme in markdown in all or most Apache Commons components.
I'd to the same here.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
[GitHub] [httpcomponents-client] ok2c commented on a change in pull request #273: Convert README to markdown
Posted by GitBox <gi...@apache.org>.
ok2c commented on a change in pull request #273:
URL: https://github.com/apache/httpcomponents-client/pull/273#discussion_r548317438
##########
File path: README.md
##########
@@ -3,30 +3,44 @@ Apache HttpComponents Client
Welcome to the HttpClient component of the Apache HttpComponents project.
+[](https://travis-ci.com/apache/httpcomponents-client)
+[](https://maven-badges.herokuapp.com/maven-central/org.apache.httpcomponents.client5/httpclient5)
+[](https://opensource.org/licenses/Apache-2.0)
+
Building Instructions
---------------------
-For building from source instructions please refer to BUILDING.txt.
+For building from source instructions please refer to [BUILDING.txt](./BUILDING.txt).
Dependencies
------------
HttpClient main module requires Java 7 compatible runtime and
depends on the following external libraries:
-* Apache HttpComponents HttpCore
-* Apache Logging Log4j2 API
-* Apache Commons Codec
+* [Apache HttpComponents HttpCore](https://github.com/apache/httpcomponents-core)
+* [Apache Logging Log4j2 API](https://github.com/apache/logging-log4j2)
Review comment:
@michael-o It is not old but wrong. The correct dependencies are
* Apache HttpComponents HttpCore
* SLF4J
* Apache Commons Codec
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org
[GitHub] [httpcomponents-client] ok2c commented on pull request #273: Convert README to markdown
Posted by GitBox <gi...@apache.org>.
ok2c commented on pull request #273:
URL: https://github.com/apache/httpcomponents-client/pull/273#issuecomment-750919597
@michael-o @garydgregory Fine by me. Let us remove README.txt from both core and client.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@hc.apache.org
For additional commands, e-mail: dev-help@hc.apache.org