Commit 425efba2 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab

Merge branch 'docs-next' of git://git.lwn.net/linux into devel/docs-next

* '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
parents e6e9c9b2 54721886
...@@ -6,6 +6,8 @@ ...@@ -6,6 +6,8 @@
# To add a new book the only step required is to add the book to the # To add a new book the only step required is to add the book to the
# list of DOCBOOKS. # list of DOCBOOKS.
ifeq ($(IGNORE_DOCBOOKS),)
DOCBOOKS := z8530book.xml device-drivers.xml \ DOCBOOKS := z8530book.xml device-drivers.xml \
kernel-hacking.xml kernel-locking.xml deviceiobook.xml \ kernel-hacking.xml kernel-locking.xml deviceiobook.xml \
writing_usb_driver.xml networking.xml \ writing_usb_driver.xml networking.xml \
...@@ -215,6 +217,20 @@ silent_gen_xml = : ...@@ -215,6 +217,20 @@ silent_gen_xml = :
-e "s/>/\\>/g"; \ -e "s/>/\\>/g"; \
echo "</programlisting>") > $@ 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 # Help targets as used by the top-level makefile
dochelp: dochelp:
...@@ -229,6 +245,9 @@ dochelp: ...@@ -229,6 +245,9 @@ dochelp:
@echo @echo
@echo ' make DOCBOOKS="s1.xml s2.xml" [target] Generate only docs s1.xml s2.xml' @echo ' make DOCBOOKS="s1.xml s2.xml" [target] Generate only docs s1.xml s2.xml'
@echo ' valid values for DOCBOOKS are: $(DOCBOOKS)' @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)'
### ###
......
...@@ -17,6 +17,12 @@ ifeq ($(HAVE_SPHINX),0) ...@@ -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.) $(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." @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 else # HAVE_SPHINX
# User-friendly check for rst2pdf # User-friendly check for rst2pdf
...@@ -57,6 +63,7 @@ sgmldocs: ...@@ -57,6 +63,7 @@ sgmldocs:
psdocs: psdocs:
mandocs: mandocs:
installmandocs: installmandocs:
cleanmediadocs:
cleandocs: cleandocs:
$(Q)rm -rf $(BUILDDIR) $(Q)rm -rf $(BUILDDIR)
......
...@@ -5,12 +5,12 @@ This document will describe OCFS2 online file check feature. ...@@ -5,12 +5,12 @@ This document will describe OCFS2 online file check feature.
Introduction 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 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 necessary, since turning the filesystem read-only would affect other running
processes as well, decreasing availability. processes as well, decreasing availability.
Then, a mount option (errors=continue) is introduced, which would return the 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 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 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. log. The user can try to check/fix this file via online filecheck feature.
...@@ -44,7 +44,7 @@ There is a sysfs directory for each OCFS2 file system mounting: ...@@ -44,7 +44,7 @@ There is a sysfs directory for each OCFS2 file system mounting:
/sys/fs/ocfs2/<devname>/filecheck /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 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 communicate with kernel space, tell which file(inode number) will be checked or
fixed. Currently, three operations are supported, which includes checking fixed. Currently, three operations are supported, which includes checking
...@@ -76,14 +76,14 @@ The output is like this: ...@@ -76,14 +76,14 @@ The output is like this:
This time, the <ERROR> column indicates whether this fix is successful or not. 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 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: adjust the size like this:
# echo "<size>" > /sys/fs/ocfs2/<devname>/filecheck/set # echo "<size>" > /sys/fs/ocfs2/<devname>/filecheck/set
Fixing stuff 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 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, 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. the inode must first be checked for errors before performing a final fix.
......
...@@ -169,7 +169,7 @@ resources, scheduled and executed. ...@@ -169,7 +169,7 @@ resources, scheduled and executed.
WQ_UNBOUND WQ_UNBOUND
Work items queued to an unbound wq are served by the special 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 specific CPU. This makes the wq behave as a simple execution
context provider without concurrency management. The unbound context provider without concurrency management. The unbound
worker-pools try to start execution of work items as soon as worker-pools try to start execution of work items as soon as
......
...@@ -1414,7 +1414,7 @@ $(help-board-dirs): help-%: ...@@ -1414,7 +1414,7 @@ $(help-board-dirs): help-%:
# Documentation targets # 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) PHONY += $(DOC_TARGETS)
$(DOC_TARGETS): scripts_basic FORCE $(DOC_TARGETS): scripts_basic FORCE
$(Q)$(MAKE) $(build)=scripts build_docproc build_check-lc_ctype $(Q)$(MAKE) $(build)=scripts build_docproc build_check-lc_ctype
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment