Skip to content

Commit 62666c6

Browse files
committed
Reverted README.md formatting changes
1 parent 2d5fe1c commit 62666c6

1 file changed

Lines changed: 51 additions & 79 deletions

File tree

README.md

Lines changed: 51 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -1,96 +1,75 @@
11
## Release Notes
22

3-
Release notes are available
4-
[here](https://github.com/mongodb/mongo-java-driver/releases).
3+
Release notes are available [here](https://github.com/mongodb/mongo-java-driver/releases).
54

65
## Documentation
76

8-
Reference and API documentation for the Java driver is available
9-
[here](https://www.mongodb.com/docs/drivers/java/sync/current/).
7+
Reference and API documentation for the Java driver is available [here](https://www.mongodb.com/docs/drivers/java/sync/current/).
108

11-
Reference and API documentation for the Kotlin driver is available
12-
[here](https://www.mongodb.com/docs/drivers/kotlin/coroutine/current/).
9+
Reference and API documentation for the Kotlin driver is available [here](https://www.mongodb.com/docs/drivers/kotlin/coroutine/current/).
1310

14-
Reference and API documentation for the Scala driver is available
15-
[here](https://www.mongodb.com/docs/languages/scala/scala-driver/current/).
11+
Reference and API documentation for the Scala driver is available [here](https://www.mongodb.com/docs/languages/scala/scala-driver/current/).
1612

1713
## Tutorials / Training
1814

19-
For tutorials on how to use the MongoDB JVM Drivers, please reference
20-
[MongoDB University](https://learn.mongodb.com/). Additional tutorials, videos, and code
21-
examples using both the Java Driver and the Kotlin Driver can also be found in the
22-
[MongoDB Developer Center](https://www.mongodb.com/developer/).
15+
For tutorials on how to use the MongoDB JVM Drivers, please reference [MongoDB University](https://learn.mongodb.com/). Additional tutorials, videos, and code examples using both the Java Driver and the Kotlin Driver can also be found in the [MongoDB Developer Center](https://www.mongodb.com/developer/).
2316

2417
## Support / Feedback
2518

26-
For issues with, questions about, or feedback for the MongoDB Java, Kotlin, and Scala
27-
drivers, please look into our
28-
[support channels](https://www.mongodb.com/docs/manual/support/). Please do not email
29-
any of the driver developers directly with issues or questions - you’re more likely to
30-
get an answer on the
31-
[MongoDB Community Forums](https://community.mongodb.com/tags/c/drivers-odms-connectors/7/java-driver)
32-
or [StackOverflow](https://stackoverflow.com/questions/tagged/mongodb+java).
33-
34-
At a minimum, please include in your description the exact version of the driver that
35-
you are using. If you are having connectivity issues, it’s often also useful to paste in
36-
the line of code where you construct the MongoClient instance, along with the values of
37-
all parameters that you pass to the constructor.
38-
You should also check your application logs for any connectivity-related exceptions and
39-
post those as well.
19+
For issues with, questions about, or feedback for the MongoDB Java, Kotlin, and Scala drivers, please look into
20+
our [support channels](https://www.mongodb.com/docs/manual/support/). Please
21+
do not email any of the driver developers directly with issues or
22+
questions - you're more likely to get an answer on the [MongoDB Community Forums](https://community.mongodb.com/tags/c/drivers-odms-connectors/7/java-driver) or [StackOverflow](https://stackoverflow.com/questions/tagged/mongodb+java).
23+
24+
At a minimum, please include in your description the exact version of the driver that you are using. If you are having
25+
connectivity issues, it's often also useful to paste in the line of code where you construct the MongoClient instance,
26+
along with the values of all parameters that you pass to the constructor. You should also check your application logs for
27+
any connectivity-related exceptions and post those as well.
4028

4129
## Bugs / Feature Requests
4230

43-
Think you’ve found a bug in the Java, Kotlin, or Scala drivers?
44-
Want to see a new feature in the drivers?
45-
Please open a case in our issue management tool, JIRA:
31+
Think you’ve found a bug in the Java, Kotlin, or Scala drivers? Want to see a new feature in the drivers? Please open a
32+
case in our issue management tool, JIRA:
4633

4734
- [Create an account and login](https://jira.mongodb.org).
4835
- Navigate to [the JAVA project](https://jira.mongodb.org/browse/JAVA).
49-
- Click **Create Issue** - Please provide as much information as possible about the
50-
issue type, which driver you are using, and how to reproduce your issue.
36+
- Click **Create Issue** - Please provide as much information as possible about the issue type, which driver you are using, and how to reproduce your issue.
5137

52-
Bug reports in JIRA for the driver and the Core Server (i.e. SERVER) project are
53-
**public**.
38+
Bug reports in JIRA for the driver and the Core Server (i.e. SERVER) project are **public**.
5439

55-
If you’ve identified a security vulnerability in a driver or any other MongoDB project,
56-
please report it according to the
57-
[instructions here](https://www.mongodb.com/docs/manual/tutorial/create-a-vulnerability-report).
40+
If you’ve identified a security vulnerability in a driver or any other
41+
MongoDB project, please report it according to the [instructions here](https://www.mongodb.com/docs/manual/tutorial/create-a-vulnerability-report).
5842

5943
## Versioning
6044

6145
We follow [semantic versioning](https://semver.org/spec/v2.0.0.html) when releasing.
6246

6347
#### @Alpha
6448

65-
APIs marked with the `@Alpha` annotation are in the early stages of development, subject
66-
to incompatible changes, or even removal, in a future release and may lack some intended
67-
features. An APIs bearing `@Alpha` annotation may contain known issues affecting
68-
functionality, performance, and stability.
69-
They are also exempt from any compatibility guarantees made by its containing library.
49+
APIs marked with the `@Alpha` annotation are in the early stages of development, subject to incompatible changes,
50+
or even removal, in a future release and may lack some intended features. An APIs bearing `@Alpha` annotation may
51+
contain known issues affecting functionality, performance, and stability. They are also exempt from any compatibility
52+
guarantees made by its containing library.
7053

71-
It is inadvisable for <i>applications</i> to use Alpha APIs in production environments
72-
or for <i>libraries</i> (which get included on users’ CLASSPATHs, outside the library
73-
developers’ control) to depend on these APIs.
74-
Alpha APIs are intended for <b>experimental purposes</b> only.
54+
It is inadvisable for <i>applications</i> to use Alpha APIs in production environments or for <i>libraries</i>
55+
(which get included on users' CLASSPATHs, outside the library developers' control) to depend on these APIs. Alpha APIs
56+
are intended for <b>experimental purposes</b> only.
7557

7658
#### @Beta
7759

78-
APIs marked with the `@Beta` annotation at the class or method level are subject to
79-
change. They can be modified in any way, or even removed, at any time.
80-
If your code is a library itself (i.e. it is used on the CLASSPATH of users outside your
81-
own control), you should not use beta APIs, unless you repackage them (e.g. by using
82-
shading, etc).
60+
APIs marked with the `@Beta` annotation at the class or method level are subject to change. They can be modified in any way, or even
61+
removed, at any time. If your code is a library itself (i.e. it is used on the CLASSPATH of users outside your own control), you should not
62+
use beta APIs, unless you repackage them (e.g. by using shading, etc).
8363

8464
#### @Deprecated
8565

86-
APIs marked with the `@Deprecated` annotation at the class or method level will remain
87-
supported until the next major release but it is recommended to stop using them.
66+
APIs marked with the `@Deprecated` annotation at the class or method level will remain supported until the next major release but it is
67+
recommended to stop using them.
8868

8969
#### com.mongodb.internal.*
9070

91-
All code inside the `com.mongodb.internal.*` packages is considered private API and
92-
should not be relied upon at all.
93-
It can change at any time.
71+
All code inside the `com.mongodb.internal.*` packages is considered private API and should not be relied upon at all. It can change at any
72+
time.
9473

9574
## Binaries
9675

@@ -106,7 +85,6 @@ Example for Maven:
10685
<version>x.y.z</version>
10786
</dependency>
10887
```
109-
11088
Snapshot builds are also published regularly via Sonatype.
11189

11290
Example for Maven:
@@ -129,26 +107,23 @@ Example for Maven:
129107

130108
## Build
131109

132-
Java 17+ and git is required to build and compile the source.
133-
To build and test the driver:
110+
Java 17+ and git is required to build and compile the source. To build and test the driver:
134111

135112
```
136113
$ git clone --recurse-submodules https://github.com/mongodb/mongo-java-driver.git
137114
$ cd mongo-java-driver
138115
$ ./gradlew check
139116
```
140117

141-
The test suite requires mongod to be running with
142-
[`enableTestCommands`](https://www.mongodb.com/docs/manual/reference/parameters/#param.enableTestCommands),
143-
which may be set with the `--setParameter enableTestCommands=1` command-line parameter:
118+
The test suite requires mongod to be running with [`enableTestCommands`](https://www.mongodb.com/docs/manual/reference/parameters/#param.enableTestCommands), which may be set with the `--setParameter enableTestCommands=1`
119+
command-line parameter:
144120
```
145121
$ mkdir -p data/db
146122
$ mongod --dbpath ./data/db --logpath ./data/mongod.log --port 27017 --logappend --fork --setParameter enableTestCommands=1
147123
```
148124

149-
If you encounter `"Too many open files"` errors when running the tests then you will
150-
need to increase the number of available file descriptors prior to starting mongod as
151-
described in https://www.mongodb.com/docs/manual/reference/ulimit/
125+
If you encounter `"Too many open files"` errors when running the tests then you will need to increase
126+
the number of available file descriptors prior to starting mongod as described in [https://www.mongodb.com/docs/manual/reference/ulimit/](https://www.mongodb.com/docs/manual/reference/ulimit/)
152127

153128
## AI Agent Configuration
154129

@@ -168,18 +143,15 @@ A couple of manual configuration steps are required to run the code in IntelliJ:
168143

169144
- Java 17+ is required to build and compile the source.
170145

171-
- **Error:**
172-
`java: cannot find symbol: class SNIHostName location: package javax.net.ssl`<br>
173-
**Fix:** Settings/Preferences > Build, Execution, Deployment > Compiler > Java
174-
Compiler - untick “Use '--release' option for cross-compilation (Java 9 and later)”
175-
176-
- **Error:** `java: package com.mongodb.internal.build does not exist`<br> **Fixes:**
177-
Any of the following: <br>
178-
- Run the `generateBuildConfig` task: eg: `./gradlew generateBuildConfig` or via
179-
Gradle > driver-core > Tasks > buildconfig > generateBuildConfig
180-
- Set `generateBuildConfig` to execute Before Build.
181-
via Gradle > Tasks > buildconfig > right click generateBuildConfig - click on
182-
“Execute Before Build”
183-
- Delegate all build actions to Gradle: Settings/Preferences > Build, Execution,
184-
Deployment > Build Tools > Gradle > Build and run using/Run tests using - select
185-
“Gradle”
146+
- **Error:** `java: cannot find symbol: class SNIHostName location: package javax.net.ssl`<br>
147+
**Fix:** Settings/Preferences > Build, Execution, Deployment > Compiler > Java Compiler - untick "Use '--release' option for
148+
cross-compilation (Java 9 and later)"
149+
150+
- **Error:** `java: package com.mongodb.internal.build does not exist`<br>
151+
**Fixes:** Any of the following: <br>
152+
- Run the `generateBuildConfig` task: eg: `./gradlew generateBuildConfig` or via Gradle > driver-core > Tasks > buildconfig >
153+
generateBuildConfig
154+
- Set `generateBuildConfig` to execute Before Build. via Gradle > Tasks > buildconfig > right click generateBuildConfig - click on
155+
"Execute Before Build"
156+
- Delegate all build actions to Gradle: Settings/Preferences > Build, Execution, Deployment > Build Tools > Gradle > Build and run
157+
using/Run tests using - select "Gradle"

0 commit comments

Comments
 (0)