From duke at openjdk.java.net Mon Jan 3 10:04:25 2022 From: duke at openjdk.java.net (Ludvig Janiuk) Date: Mon, 3 Jan 2022 10:04:25 GMT Subject: RFR: Add start on a section about logging [v2] In-Reply-To: References: Message-ID: <0KnGwHIltlQWpstxxk5HyucnhOsQHLJFtKQz3o9S4pc=.a39ea01c-2352-425c-b996-74ea0227215d@github.com> On Mon, 20 Dec 2021 09:24:20 GMT, Ludvig Janiuk wrote: >> It's hard to find information on how one should write logging code in Hotspot. This PR is only a first attempt at pointing the reader in the right direction, but a lot could be added in the future: >> * In which contexts can one not use unified logging? >> * How much should one log? >> * What other logging strategies are there? > > Ludvig Janiuk has updated the pull request incrementally with one additional commit since the last revision: > > cleanup The fact is that there isn't a hotspot specific developer guide as of now. What's important to me is getting stuff like this documented *some place* a new member will find it. It's outrageous to come aboard as a new JVM developer, and have access to no documented answers to such basic necessities as logging, and just be expected to figure it out from hearsay. So could we just get it into the documentation-base as a first step, and leave discussions about perfect locations as step 2? ------------- PR: https://git.openjdk.java.net/guide/pull/70 From duke at openjdk.java.net Mon Jan 17 13:39:39 2022 From: duke at openjdk.java.net (Ludvig Janiuk) Date: Mon, 17 Jan 2022 13:39:39 GMT Subject: RFR: Add start on a section about logging [v2] In-Reply-To: References: Message-ID: On Mon, 20 Dec 2021 22:56:10 GMT, David Holmes wrote: >> Ludvig Janiuk has updated the pull request incrementally with one additional commit since the last revision: >> >> cleanup > > I think the Developer's Guide should be focused on process. It is a guide to enable people to make contributions. It cannot be a technical development guide for all different areas of the JDK - that would be completely impractical and would lead to factoring out the real "getting started" process oriented guide. > > There is a place for a Hotspot Developer's Guide to replace the wiki materials, but that should be a completely separate document IMO. > > David @dholmes-ora while the dev guide focuses largely on process, I don't think it was ever meant to exclusively cover that. In the first few paragraphs I read: > The OpenJDK Community is a fairly pragmatic place. ?Do the right thing? is most often the right course of action. Still, if people do things in the same right way then everyone?s work becomes more transparent and easier for others to follow. For this reason most parts of the development process have standard flows that are the recommended ways to do things. > The goal of this guide is to answer questions that developers of the JDK might have around development process, tooling, standards, and so forth. Logging is a question developers have. And we do have a "right way to do the thing": Unified Logging! So it seems well-aligned with the goals of the dev guide to answer that question and point people in the right direction. ------------- PR: https://git.openjdk.java.net/guide/pull/70 From jwilhelm at openjdk.java.net Mon Jan 17 14:30:52 2022 From: jwilhelm at openjdk.java.net (Jesper Wilhelmsson) Date: Mon, 17 Jan 2022 14:30:52 GMT Subject: RFR: Add start on a section about logging [v2] In-Reply-To: References: Message-ID: On Mon, 20 Dec 2021 09:24:20 GMT, Ludvig Janiuk wrote: >> It's hard to find information on how one should write logging code in Hotspot. This PR is only a first attempt at pointing the reader in the right direction, but a lot could be added in the future: >> * In which contexts can one not use unified logging? >> * How much should one log? >> * What other logging strategies are there? > > Ludvig Janiuk has updated the pull request incrementally with one additional commit since the last revision: > > cleanup I agree with Ludvig here, the guide has never been strictly about process only. Guidelines for how to clone the source code and examples of shell scripts to help development are very hands-on examples of content that has been in the Guide since the first version. I'm going to allow this section. If it turns out that we have a lot of area specific content that makes the Guide difficult to overview we can (and should) split it into separate documents later. ------------- PR: https://git.openjdk.java.net/guide/pull/70 From jwilhelm at openjdk.java.net Mon Jan 17 14:35:45 2022 From: jwilhelm at openjdk.java.net (Jesper Wilhelmsson) Date: Mon, 17 Jan 2022 14:35:45 GMT Subject: RFR: Add start on a section about logging [v2] In-Reply-To: References: Message-ID: On Mon, 20 Dec 2021 09:24:20 GMT, Ludvig Janiuk wrote: >> It's hard to find information on how one should write logging code in Hotspot. This PR is only a first attempt at pointing the reader in the right direction, but a lot could be added in the future: >> * In which contexts can one not use unified logging? >> * How much should one log? >> * What other logging strategies are there? > > Ludvig Janiuk has updated the pull request incrementally with one additional commit since the last revision: > > cleanup Marked as reviewed by jwilhelm (Lead). ------------- PR: https://git.openjdk.java.net/guide/pull/70 From duke at openjdk.java.net Mon Jan 17 15:47:00 2022 From: duke at openjdk.java.net (Ludvig Janiuk) Date: Mon, 17 Jan 2022 15:47:00 GMT Subject: RFR: Add start on a section about logging [v3] In-Reply-To: References: Message-ID: > It's hard to find information on how one should write logging code in Hotspot. This PR is only a first attempt at pointing the reader in the right direction, but a lot could be added in the future: > * In which contexts can one not use unified logging? > * How much should one log? > * What other logging strategies are there? Ludvig Janiuk has updated the pull request with a new target base due to a merge or a rebase. The pull request now contains five commits: - Merge branch 'master' into patch-2 - cleanup - fix trailing whitespace - fix - Add start on a section about logging It's hard to find information on how one should write logging code in Hotspot. This PR is only a first attempt at pointing the reader in the right direction, but a lot could be added in the futute: * In which contexts can one not use unified logging? * How much should one log? * What other logging strategies are there? ------------- Changes: https://git.openjdk.java.net/guide/pull/70/files Webrev: https://webrevs.openjdk.java.net/?repo=guide&pr=70&range=02 Stats: 34 lines in 1 file changed: 34 ins; 0 del; 0 mod Patch: https://git.openjdk.java.net/guide/pull/70.diff Fetch: git fetch https://git.openjdk.java.net/guide pull/70/head:pull/70 PR: https://git.openjdk.java.net/guide/pull/70 From duke at openjdk.java.net Mon Jan 17 16:36:44 2022 From: duke at openjdk.java.net (Ludvig Janiuk) Date: Mon, 17 Jan 2022 16:36:44 GMT Subject: Integrated: Add start on a section about logging In-Reply-To: References: Message-ID: On Fri, 17 Dec 2021 14:54:50 GMT, Ludvig Janiuk wrote: > It's hard to find information on how one should write logging code in Hotspot. This PR is only a first attempt at pointing the reader in the right direction, but a lot could be added in the future: > * In which contexts can one not use unified logging? > * How much should one log? > * What other logging strategies are there? This pull request has now been integrated. Changeset: 2fc35964 Author: Ludvig Janiuk Committer: Jesper Wilhelmsson URL: https://git.openjdk.java.net/guide/commit/2fc35964692d943b1fa9ee43c68264528c61e970 Stats: 34 lines in 1 file changed: 34 ins; 0 del; 0 mod Add start on a section about logging Reviewed-by: jwilhelm ------------- PR: https://git.openjdk.java.net/guide/pull/70 From dholmes at openjdk.java.net Tue Jan 18 01:21:45 2022 From: dholmes at openjdk.java.net (David Holmes) Date: Tue, 18 Jan 2022 01:21:45 GMT Subject: RFR: Add start on a section about logging [v3] In-Reply-To: References: Message-ID: On Mon, 17 Jan 2022 15:47:00 GMT, Ludvig Janiuk wrote: >> It's hard to find information on how one should write logging code in Hotspot. This PR is only a first attempt at pointing the reader in the right direction, but a lot could be added in the future: >> * In which contexts can one not use unified logging? >> * How much should one log? >> * What other logging strategies are there? > > Ludvig Janiuk has updated the pull request with a new target base due to a merge or a rebase. The pull request now contains five commits: > > - Merge branch 'master' into patch-2 > - cleanup > - fix trailing whitespace > - fix > - Add start on a section about logging > > It's hard to find information on how one should write logging code in Hotspot. This PR is only a first attempt at pointing the reader in the right direction, but a lot could be added in the futute: > * In which contexts can one not use unified logging? > * How much should one log? > * What other logging strategies are there? If the Developer's Guide tries to incorporate hotspot specific development/programming discussions that have nothing at all to do with general processes and are relevant only to hotspot developers, then the guide is going to be too overwhelming and harder to use for the rest of the OpenJDK Developer community IMO. YMMV. ------------- PR: https://git.openjdk.java.net/guide/pull/70 From iris at openjdk.java.net Tue Jan 18 10:12:45 2022 From: iris at openjdk.java.net (Iris Clark) Date: Tue, 18 Jan 2022 10:12:45 GMT Subject: RFR: Remove empty files In-Reply-To: <3Tp4ZYU3Ft_L-VFyPkYnyEj4upPEb2lic3eXEu5wXtc=.c87cb92f-56b4-4646-be34-5efbccd44d4f@github.com> References: <3Tp4ZYU3Ft_L-VFyPkYnyEj4upPEb2lic3eXEu5wXtc=.c87cb92f-56b4-4646-be34-5efbccd44d4f@github.com> Message-ID: <9EAI-rzsMkeQyscqIYlAC72FsvCf7xdSthMfwJZTSGc=.e7b12d47-0ff4-45da-b3ca-978454ee7dc2@github.com> On Tue, 7 Dec 2021 21:23:26 GMT, Jesper Wilhelmsson wrote: > The guide was merged into one file a year ago and since then all the old files has been in place with a forward link to the new single file. I think a year is long enough. This change removes all those forward files. Super! Thanks for remembering to remove after a suitable transition period. ------------- Marked as reviewed by iris (Reviewer). PR: https://git.openjdk.java.net/guide/pull/68 From jwilhelm at openjdk.java.net Tue Jan 18 13:14:42 2022 From: jwilhelm at openjdk.java.net (Jesper Wilhelmsson) Date: Tue, 18 Jan 2022 13:14:42 GMT Subject: Integrated: Remove empty files In-Reply-To: <3Tp4ZYU3Ft_L-VFyPkYnyEj4upPEb2lic3eXEu5wXtc=.c87cb92f-56b4-4646-be34-5efbccd44d4f@github.com> References: <3Tp4ZYU3Ft_L-VFyPkYnyEj4upPEb2lic3eXEu5wXtc=.c87cb92f-56b4-4646-be34-5efbccd44d4f@github.com> Message-ID: On Tue, 7 Dec 2021 21:23:26 GMT, Jesper Wilhelmsson wrote: > The guide was merged into one file a year ago and since then all the old files has been in place with a forward link to the new single file. I think a year is long enough. This change removes all those forward files. This pull request has now been integrated. Changeset: a4bf612f Author: Jesper Wilhelmsson URL: https://git.openjdk.java.net/guide/commit/a4bf612f478cd8868960ebe0a6050c041a78ac7d Stats: 42 lines in 14 files changed: 0 ins; 42 del; 0 mod Remove empty files Reviewed-by: iris ------------- PR: https://git.openjdk.java.net/guide/pull/68 From jwilhelm at openjdk.java.net Thu Jan 27 01:17:12 2022 From: jwilhelm at openjdk.java.net (Jesper Wilhelmsson) Date: Thu, 27 Jan 2022 01:17:12 GMT Subject: RFR: Links to top Message-ID: Added links back to the top of the document after each section. Also did minor cleanups of the text and added an example graph showing a backport hierarchy. ------------- Commit messages: - Links to top Changes: https://git.openjdk.java.net/guide/pull/72/files Webrev: https://webrevs.openjdk.java.net/?repo=guide&pr=72&range=00 Stats: 78 lines in 1 file changed: 71 ins; 0 del; 7 mod Patch: https://git.openjdk.java.net/guide/pull/72.diff Fetch: git fetch https://git.openjdk.java.net/guide pull/72/head:pull/72 PR: https://git.openjdk.java.net/guide/pull/72 From iris at openjdk.java.net Thu Jan 27 04:02:49 2022 From: iris at openjdk.java.net (Iris Clark) Date: Thu, 27 Jan 2022 04:02:49 GMT Subject: RFR: Links to top In-Reply-To: References: Message-ID: On Thu, 27 Jan 2022 01:12:17 GMT, Jesper Wilhelmsson wrote: > Added links back to the top of the document after each section. > Also did minor cleanups of the text and added an example graph showing a backport hierarchy. Marked as reviewed by iris (Reviewer). ------------- PR: https://git.openjdk.java.net/guide/pull/72 From jwilhelm at openjdk.java.net Thu Jan 27 14:37:03 2022 From: jwilhelm at openjdk.java.net (Jesper Wilhelmsson) Date: Thu, 27 Jan 2022 14:37:03 GMT Subject: Integrated: Links to top In-Reply-To: References: Message-ID: On Thu, 27 Jan 2022 01:12:17 GMT, Jesper Wilhelmsson wrote: > Added links back to the top of the document after each section. > Also did minor cleanups of the text and added an example graph showing a backport hierarchy. This pull request has now been integrated. Changeset: 3038cbe5 Author: Jesper Wilhelmsson URL: https://git.openjdk.java.net/guide/commit/3038cbe5f8d1bf213eb394c5d3b63a422509bf4b Stats: 78 lines in 1 file changed: 71 ins; 0 del; 7 mod Links to top Reviewed-by: iris ------------- PR: https://git.openjdk.java.net/guide/pull/72 From magnus.ihse.bursie at oracle.com Fri Jan 28 08:46:39 2022 From: magnus.ihse.bursie at oracle.com (Magnus Ihse Bursie) Date: Fri, 28 Jan 2022 09:46:39 +0100 Subject: Text about not using rebase/force-push in PRs..? Message-ID: <6b289d55-e051-cb11-0a2b-e689fd8c755e@oracle.com> Didn't we have some text saying not to use rebase, but use merge instead, in PRs? I wanted to send a link to a contributor that did this, but I can't find it. I could have sworn it was discussed here; did it end up never getting pushed to the guide? /Magnus From ihse at openjdk.java.net Fri Jan 28 09:08:48 2022 From: ihse at openjdk.java.net (Magnus Ihse Bursie) Date: Fri, 28 Jan 2022 09:08:48 GMT Subject: RFR: Fix typo Message-ID: <8c813nAC7eSZyYX3Hy8emw5Thrvz__JoKihREUVZEeo=.8fc9d5be-509f-4563-a7fc-563ea086c805@github.com> Fix typo. Also, add some text here to keep Skara happy. ------------- Commit messages: - Fix typo. Changes: https://git.openjdk.java.net/guide/pull/73/files Webrev: https://webrevs.openjdk.java.net/?repo=guide&pr=73&range=00 Stats: 1 line in 1 file changed: 0 ins; 0 del; 1 mod Patch: https://git.openjdk.java.net/guide/pull/73.diff Fetch: git fetch https://git.openjdk.java.net/guide pull/73/head:pull/73 PR: https://git.openjdk.java.net/guide/pull/73 From david.holmes at oracle.com Fri Jan 28 13:31:55 2022 From: david.holmes at oracle.com (David Holmes) Date: Fri, 28 Jan 2022 23:31:55 +1000 Subject: Text about not using rebase/force-push in PRs..? In-Reply-To: <6b289d55-e051-cb11-0a2b-e689fd8c755e@oracle.com> References: <6b289d55-e051-cb11-0a2b-e689fd8c755e@oracle.com> Message-ID: <633aff9b-6329-68dd-3637-fd1e53f6df5f@oracle.com> On 28/01/2022 6:46 pm, Magnus Ihse Bursie wrote: > Didn't we have some text saying not to use rebase, but use merge > instead, in PRs? I wanted to send a link to a contributor that did this, > but I can't find it. I could have sworn it was discussed here; did it > end up never getting pushed to the guide? It is in the Skara FAQ: https://wiki.openjdk.java.net/display/SKARA/FAQ How do I modify the changes in a pull request? To modify your patch in a pull request, just push more changes to the branch the pull request is based on. Avoid modifying changes that are already part of the pull request branch or force pushing unrelated changes as that will mess up the pull request and make it hard for reviewers to make sense of it. When Skara integrates the pull request, all the changes will be squashed into a single change anyway. -- David > /Magnus From darcy at openjdk.java.net Fri Jan 28 17:58:27 2022 From: darcy at openjdk.java.net (Joe Darcy) Date: Fri, 28 Jan 2022 17:58:27 GMT Subject: RFR: Fix typo In-Reply-To: <8c813nAC7eSZyYX3Hy8emw5Thrvz__JoKihREUVZEeo=.8fc9d5be-509f-4563-a7fc-563ea086c805@github.com> References: <8c813nAC7eSZyYX3Hy8emw5Thrvz__JoKihREUVZEeo=.8fc9d5be-509f-4563-a7fc-563ea086c805@github.com> Message-ID: On Fri, 28 Jan 2022 08:55:05 GMT, Magnus Ihse Bursie wrote: > Fix typo. Also, add some text here to keep Skara happy. Marked as reviewed by darcy (Committer). ------------- PR: https://git.openjdk.java.net/guide/pull/73 From iris at openjdk.java.net Fri Jan 28 18:07:27 2022 From: iris at openjdk.java.net (Iris Clark) Date: Fri, 28 Jan 2022 18:07:27 GMT Subject: RFR: Fix typo In-Reply-To: <8c813nAC7eSZyYX3Hy8emw5Thrvz__JoKihREUVZEeo=.8fc9d5be-509f-4563-a7fc-563ea086c805@github.com> References: <8c813nAC7eSZyYX3Hy8emw5Thrvz__JoKihREUVZEeo=.8fc9d5be-509f-4563-a7fc-563ea086c805@github.com> Message-ID: On Fri, 28 Jan 2022 08:55:05 GMT, Magnus Ihse Bursie wrote: > Fix typo. Also, add some text here to keep Skara happy. Marked as reviewed by iris (Reviewer). ------------- PR: https://git.openjdk.java.net/guide/pull/73 From jesper.wilhelmsson at oracle.com Sat Jan 29 00:42:20 2022 From: jesper.wilhelmsson at oracle.com (Jesper Wilhelmsson) Date: Sat, 29 Jan 2022 00:42:20 +0000 Subject: Text about not using rebase/force-push in PRs..? In-Reply-To: <6b289d55-e051-cb11-0a2b-e689fd8c755e@oracle.com> References: <6b289d55-e051-cb11-0a2b-e689fd8c755e@oracle.com> Message-ID: <2954AE67-17A2-4E1D-ABA6-0E867BBD866D@oracle.com> That was discussed and it is on my todo list to add something about this in the guide. /Jesper > 28 jan. 2022 kl. 09:47 skrev Magnus Ihse Bursie : > > ?Didn't we have some text saying not to use rebase, but use merge instead, in PRs? I wanted to send a link to a contributor that did this, but I can't find it. I could have sworn it was discussed here; did it end up never getting pushed to the guide? > > /Magnus From ihse at openjdk.java.net Mon Jan 31 11:21:26 2022 From: ihse at openjdk.java.net (Magnus Ihse Bursie) Date: Mon, 31 Jan 2022 11:21:26 GMT Subject: Integrated: Fix typo In-Reply-To: <8c813nAC7eSZyYX3Hy8emw5Thrvz__JoKihREUVZEeo=.8fc9d5be-509f-4563-a7fc-563ea086c805@github.com> References: <8c813nAC7eSZyYX3Hy8emw5Thrvz__JoKihREUVZEeo=.8fc9d5be-509f-4563-a7fc-563ea086c805@github.com> Message-ID: On Fri, 28 Jan 2022 08:55:05 GMT, Magnus Ihse Bursie wrote: > Fix typo. Also, add some text here to keep Skara happy. This pull request has now been integrated. Changeset: 2454b164 Author: Magnus Ihse Bursie URL: https://git.openjdk.java.net/guide/commit/2454b16474789e1eb7c7522f343daf1d44fcb6f7 Stats: 1 line in 1 file changed: 0 ins; 0 del; 1 mod Fix typo Reviewed-by: darcy, iris ------------- PR: https://git.openjdk.java.net/guide/pull/73