@@ -253,31 +253,31 @@ To scan for the reachability of external links, execute:
253253
254254 admin/build-doc linkcheck
255255
256- Executing ``admin/build-doc `` will create a ``build-doc `` directory under
256+ Running ``admin/build-doc `` creates a ``build-doc `` directory under
257257``ceph ``. You may need to create a directory under ``ceph/build-doc `` for
258- output of Javadoc files :
258+ Javadoc file output :
259259
260260.. prompt :: bash $
261261
262262 mkdir -p output/html/api/libcephfs-java/javadoc
263263
264- The build script ``build-doc `` will produce an output of errors and warnings.
265- You MUST fix errors in documents you modified before committing a change, and
266- you SHOULD fix warnings that are related to syntax you modified.
264+ The build script ``build-doc `` produces output partially consisting of errors
265+ and warnings. You MUST fix errors in documents you modified before committing
266+ a change, and you SHOULD fix warnings that are related to syntax you modified.
267267
268268.. important :: You must validate ALL HYPERLINKS. If a hyperlink is broken,
269269 it automatically breaks the build!
270270
271- Once you build the documentation set, you may start an HTTP server at
272- ``http://localhost:8080/ `` to view it:
271+ After you have built the documentation set, you may start an HTTP server at
272+ ``http://localhost:8080/ `` to view it by running the following command :
273273
274274.. prompt :: bash $
275275
276276 admin/serve-doc
277277
278278You can also navigate to ``build-doc/output `` to inspect the built documents.
279- There should be an ``html `` directory and a ``man `` directory containing
280- documentation in HTML and manpage formats respectively.
279+ Within `` build-doc/output `` is an ``html `` directory and a ``man `` directory
280+ containing documentation in HTML and manpage formats respectively.
281281
282282Build the Source (First Time)
283283~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
0 commit comments