Skip to content

Commit

Permalink
Merge branch 'docs-next' of git://git.lwn.net/linux into devel/docs-next
Browse files Browse the repository at this point in the history
* 'docs-next' of git://git.lwn.net/linux:
  doc-rst: add an option to ignore DocBooks when generating docs
  workqueue: Fix a typo in workqueue.txt
  Doc: ocfs: Fix typo in filesystems/ocfs2-online-filecheck.txt
  Documentation/sphinx: skip build if user requested specific DOCBOOKS
  Documentation: add cleanmediadocs to the documentation targets
  • Loading branch information
mchehab committed Jul 15, 2016
2 parents e6e9c9b + 5472188 commit 425efba
Show file tree
Hide file tree
Showing 5 changed files with 33 additions and 7 deletions.
19 changes: 19 additions & 0 deletions Documentation/DocBook/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
# To add a new book the only step required is to add the book to the
# list of DOCBOOKS.

ifeq ($(IGNORE_DOCBOOKS),)

DOCBOOKS := z8530book.xml device-drivers.xml \
kernel-hacking.xml kernel-locking.xml deviceiobook.xml \
writing_usb_driver.xml networking.xml \
Expand Down Expand Up @@ -215,6 +217,20 @@ silent_gen_xml = :
-e "s/>/\\>/g"; \
echo "</programlisting>") > $@

else

# Needed, due to cleanmediadocs
include Documentation/DocBook/media/Makefile

htmldocs:
pdfdocs:
psdocs:
xmldocs:
installmandocs:

endif # IGNORE_DOCBOOKS


###
# Help targets as used by the top-level makefile
dochelp:
Expand All @@ -229,6 +245,9 @@ dochelp:
@echo
@echo ' make DOCBOOKS="s1.xml s2.xml" [target] Generate only docs s1.xml s2.xml'
@echo ' valid values for DOCBOOKS are: $(DOCBOOKS)'
@echo
@echo " make IGNORE_DOCBOOKS=1 [target] Don't generate docs from Docbook"
@echo ' This is useful to generate only the ReST docs (Sphinx)'


###
Expand Down
7 changes: 7 additions & 0 deletions Documentation/Makefile.sphinx
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@ ifeq ($(HAVE_SPHINX),0)
$(warning The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed and in PATH, or set the SPHINXBUILD make variable to point to the full path of the '$(SPHINXBUILD)' executable.)
@echo " SKIP Sphinx $@ target."

else ifneq ($(DOCBOOKS),)

# Skip Sphinx build if the user explicitly requested DOCBOOKS.
.DEFAULT:
@echo " SKIP Sphinx $@ target (DOCBOOKS specified)."

else # HAVE_SPHINX

# User-friendly check for rst2pdf
Expand Down Expand Up @@ -57,6 +63,7 @@ sgmldocs:
psdocs:
mandocs:
installmandocs:
cleanmediadocs:

cleandocs:
$(Q)rm -rf $(BUILDDIR)
Expand Down
10 changes: 5 additions & 5 deletions Documentation/filesystems/ocfs2-online-filecheck.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ This document will describe OCFS2 online file check feature.

Introduction
============
OCFS2 is often used in high-availaibility systems. However, OCFS2 usually
OCFS2 is often used in high-availability systems. However, OCFS2 usually
converts the filesystem to read-only when encounters an error. This may not be
necessary, since turning the filesystem read-only would affect other running
processes as well, decreasing availability.
Then, a mount option (errors=continue) is introduced, which would return the
-EIO errno to the calling process and terminate furhter processing so that the
-EIO errno to the calling process and terminate further processing so that the
filesystem is not corrupted further. The filesystem is not converted to
read-only, and the problematic file's inode number is reported in the kernel
log. The user can try to check/fix this file via online filecheck feature.
Expand Down Expand Up @@ -44,7 +44,7 @@ There is a sysfs directory for each OCFS2 file system mounting:

/sys/fs/ocfs2/<devname>/filecheck

Here, <devname> indicates the name of OCFS2 volumn device which has been already
Here, <devname> indicates the name of OCFS2 volume device which has been already
mounted. The file above would accept inode numbers. This could be used to
communicate with kernel space, tell which file(inode number) will be checked or
fixed. Currently, three operations are supported, which includes checking
Expand Down Expand Up @@ -76,14 +76,14 @@ The output is like this:
This time, the <ERROR> column indicates whether this fix is successful or not.

3. The record cache is used to store the history of check/fix results. It's
defalut size is 10, and can be adjust between the range of 10 ~ 100. You can
default size is 10, and can be adjust between the range of 10 ~ 100. You can
adjust the size like this:

# echo "<size>" > /sys/fs/ocfs2/<devname>/filecheck/set

Fixing stuff
============
On receivng the inode, the filesystem would read the inode and the
On receiving the inode, the filesystem would read the inode and the
file metadata. In case of errors, the filesystem would fix the errors
and report the problems it fixed in the kernel log. As a precautionary measure,
the inode must first be checked for errors before performing a final fix.
Expand Down
2 changes: 1 addition & 1 deletion Documentation/workqueue.txt
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ resources, scheduled and executed.
WQ_UNBOUND

Work items queued to an unbound wq are served by the special
woker-pools which host workers which are not bound to any
worker-pools which host workers which are not bound to any
specific CPU. This makes the wq behave as a simple execution
context provider without concurrency management. The unbound
worker-pools try to start execution of work items as soon as
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -1414,7 +1414,7 @@ $(help-board-dirs): help-%:

# Documentation targets
# ---------------------------------------------------------------------------
DOC_TARGETS := xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs epubdocs cleandocs
DOC_TARGETS := xmldocs sgmldocs psdocs pdfdocs htmldocs mandocs installmandocs epubdocs cleandocs cleanmediadocs
PHONY += $(DOC_TARGETS)
$(DOC_TARGETS): scripts_basic FORCE
$(Q)$(MAKE) $(build)=scripts build_docproc build_check-lc_ctype
Expand Down

0 comments on commit 425efba

Please sign in to comment.