You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@logging.apache.org by GitBox <gi...@apache.org> on 2020/07/20 02:29:38 UTC

[GitHub] [logging-log4cxx] stephen-webb opened a new pull request #30: Documentation changes for release

stephen-webb opened a new pull request #30:
URL: https://github.com/apache/logging-log4cxx/pull/30


   This PR removes the maven generated Dependencies page from the web site.
   
   The maven generated dependencies report is not appropriate for a C++ project.


----------------------------------------------------------------
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



[GitHub] [logging-log4cxx] ams-tschoening commented on a change in pull request #30: Documentation changes for release

Posted by GitBox <gi...@apache.org>.
ams-tschoening commented on a change in pull request #30:
URL: https://github.com/apache/logging-log4cxx/pull/30#discussion_r457169943



##########
File path: INSTALL
##########
@@ -15,24 +15,16 @@ limitations under the License.
 
 Detailed build instructions are provided for in both HTML
 and APT format in releases.  The APT sources are 
-available in Subversion checkouts.
+available in Git checkouts.
 
 autotools:
 site/building/autotools.html
 src/site/apt/building/autotools.apt
 
-Apache Ant:
-site/building/ant.html
-src/site/apt/building/ant.apt
+CMake:

Review comment:
       How about using alphabetical order in this file? I've changed it at [the corresponding place](https://github.com/apache/logging-log4cxx/commit/96ef6546993a04e954bee4db4f0791a8138f3e00) as well.

##########
File path: INSTALL
##########
@@ -15,24 +15,16 @@ limitations under the License.
 
 Detailed build instructions are provided for in both HTML
 and APT format in releases.  The APT sources are 
-available in Subversion checkouts.
+available in Git checkouts.
 
 autotools:
 site/building/autotools.html
 src/site/apt/building/autotools.apt
 
-Apache Ant:
-site/building/ant.html
-src/site/apt/building/ant.apt
+CMake:
+site/building/cmake.html
+src/site/apt/building/cmake.apt
 
 Apache Maven 2:
 site/building/maven.html
 src/site/apt/building/maven.apt
-
-Microsoft Visual Studio:

Review comment:
       How about changing that to vcpkg? You did that [at other places](https://github.com/apache/logging-log4cxx/commit/e64b7cf0fbdd2f799cd83a7361d4ceefb75eff84#diff-7f6195436d46cda43818b2013775e6feR117) as well.
   
   Please commit removing [vstudio.apt](https://github.com/apache/logging-log4cxx/blob/master/src/site/apt/building/vstudio.apt) as well.

##########
File path: pom.xml
##########
@@ -372,7 +372,6 @@
 					<reportSet>
 						<reports>
 							<report>scm</report>
-							<report>dependencies</report>

Review comment:
       Why do you want to remove [that page](https://logging.apache.org/log4cxx/next_stable/dependencies.html)? It currently somewhat documents that `log4j` is necessary for the tests, doesn't look too wrong to me. It would like to keep it for now.

##########
File path: src/site/xdoc/building/index.xml
##########
@@ -54,10 +54,10 @@
 				<thead>
 					<tr>
 						<th id="os">OS</th>
-						<th id="os_x86_x64">x86 vs. x64</th>
+						<th id="os_x86_x64">Architecture</th>

Review comment:
       Introducing a new header name is fine, but I suggest renaming those `*_x86_x64` phrases to `*_arch` as well. Things are clearer this way.




----------------------------------------------------------------
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



[GitHub] [logging-log4cxx] stephen-webb commented on a change in pull request #30: Documentation changes for release

Posted by GitBox <gi...@apache.org>.
stephen-webb commented on a change in pull request #30:
URL: https://github.com/apache/logging-log4cxx/pull/30#discussion_r457273830



##########
File path: pom.xml
##########
@@ -372,7 +372,6 @@
 					<reportSet>
 						<reports>
 							<report>scm</report>
-							<report>dependencies</report>

Review comment:
       I was trying to add the compile time dependencies (APR, APR-Util) and the testcase dependencies (sed, zip, gzip) to the report, but could not because the maven expects all entries in dependencies to be jar files.
   
   I can only think that the dependencies have to be mentioned elsewhere in documentation (hence the the building page change). With the nav bar Dependencies, that is the first place you look, and it is just basically wrong.




----------------------------------------------------------------
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



[GitHub] [logging-log4cxx] stephen-webb commented on a change in pull request #30: Documentation changes for release

Posted by GitBox <gi...@apache.org>.
stephen-webb commented on a change in pull request #30:
URL: https://github.com/apache/logging-log4cxx/pull/30#discussion_r457273830



##########
File path: pom.xml
##########
@@ -372,7 +372,6 @@
 					<reportSet>
 						<reports>
 							<report>scm</report>
-							<report>dependencies</report>

Review comment:
       I was trying to add the compile time dependencies (APR, APR-Util) and the testcase dependencies (sed, zip, gzip) to the report, but could not because the maven expects all entries in dependencies to be jar files.
   
   I can only see that the dependencies can be mention elsewhere in documentation (hence the the building page change).




----------------------------------------------------------------
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



[GitHub] [logging-log4cxx] ams-tschoening closed pull request #30: Documentation changes for release

Posted by GitBox <gi...@apache.org>.
ams-tschoening closed pull request #30:
URL: https://github.com/apache/logging-log4cxx/pull/30


   


----------------------------------------------------------------
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



[GitHub] [logging-log4cxx] ams-tschoening commented on a change in pull request #30: Documentation changes for release

Posted by GitBox <gi...@apache.org>.
ams-tschoening commented on a change in pull request #30:
URL: https://github.com/apache/logging-log4cxx/pull/30#discussion_r457926498



##########
File path: pom.xml
##########
@@ -372,7 +372,6 @@
 					<reportSet>
 						<reports>
 							<report>scm</report>
-							<report>dependencies</report>

Review comment:
       According to comments on the SO-question I created the following result as an example:
   
   ![Clipboard01](https://user-images.githubusercontent.com/6223655/88031086-64edbe00-cb3c-11ea-8f17-479c7d856053.png)
   
   The problem is to find the binaries, I didn't find something suitable for ZIP and GZIP yet. GREP is only used as an additional example because it was easily available. In theory we could create our own `pom.xml` describing the individual missing dependencies and maintain those with the project. OTOH this might not be easier instead of simply writing text like you have done already, but that should be a bit more prominent than. I like the scope-stuff already provided by Maven, though.
   
   Thoughts?




----------------------------------------------------------------
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



[GitHub] [logging-log4cxx] ams-tschoening commented on a change in pull request #30: Documentation changes for release

Posted by GitBox <gi...@apache.org>.
ams-tschoening commented on a change in pull request #30:
URL: https://github.com/apache/logging-log4cxx/pull/30#discussion_r457335062



##########
File path: pom.xml
##########
@@ -372,7 +372,6 @@
 					<reportSet>
 						<reports>
 							<report>scm</report>
-							<report>dependencies</report>

Review comment:
       I get your point and tried the same in the past and failed as well. Tried again now and came up with some hacky approach:
   
   	<dependency>
   		<groupId>apr</groupId>
   		<artifactId>util</artifactId>
   		<version>1.5.4</version>
   		<scope>system</scope>
   		<systemPath>${user.home}/Documents/Svn/Src/Libs/trunk/C/X-OS/APR/apr-util/1.5.4/build/RAD 10.2/libs/libapr-util/Win32/Debug/out/libapr-util.lib</systemPath>
   		<type>lib</type>
   	</dependency>
   
   That makes the build succeed and adds dependencies to the page, but still prints an error message and would be best to avoid any hard-coded path. I've [asked on SO](https://stackoverflow.com/questions/62995298/how-to-model-non-java-dependencies-not-available-in-any-repository-using-maven) about that problem, maybe there's some solution with keeping the plugin we are just not aware of.




----------------------------------------------------------------
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



[GitHub] [logging-log4cxx] ams-tschoening commented on pull request #30: Documentation changes for release

Posted by GitBox <gi...@apache.org>.
ams-tschoening commented on pull request #30:
URL: https://github.com/apache/logging-log4cxx/pull/30#issuecomment-670854807


   Closing here in favour of #35, that contains all the commits here already.


----------------------------------------------------------------
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