procutil: make stream detection in make_line_buffered more correct and strict In make_line_buffered(), we don’t want to wrap the stream if we know that lines get flushed to the underlying raw stream already. Previously, the heuristic was too optimistic. It assumed that any stream which is not an instance of io.BufferedIOBase doesn’t need wrapping. However, there are buffered streams that aren’t instances of io.BufferedIOBase, like Mercurial’s own winstdout. The new logic is different in two ways: First, only for the check, if unwraps any combination of WriteAllWrapper and winstdout. Second, it skips wrapping the stream only if it is an instance of io.RawIOBase (or already wrapped). If it is an instance of io.BufferedIOBase, it gets wrapped. In any other case, the function raises an exception. This ensures that, if an unknown stream is passed or we add another wrapper in the future, we don’t wrap the stream if it’s already line buffered or not wrap the stream if it’s not line buffered. In fact, this was already helpful during development of this change. Without it, I possibly would have forgot that WriteAllWrapper needs to be ignored for the check, leading to unnecessary wrapping if stdout is unbuffered. The alternative would have been to always wrap unknown streams. However, I don’t think that anyone would benefit from being less strict. We can expect streams from the standard library to be subclassing either io.RawIOBase or io.BufferedIOBase, so running Mercurial in the standard way should not regress by this change. Py2exe might replace sys.stdout and sys.stderr, but that currently breaks Mercurial anyway and also these streams don’t claim to be interactive, so this function is not called for them.

     1

SOURCES=$(notdir $(wildcard ../mercurial/helptext/*.[0-9].txt))

     2

MAN=$(SOURCES:%.txt=%)

     3

HTML=$(SOURCES:%.txt=%.html)

     4

GENDOC=gendoc.py ../mercurial/commands.py ../mercurial/help.py \

     5

	../mercurial/helptext/*.txt ../hgext/*.py ../hgext/*/__init__.py

     6

PREFIX=/usr/local

     7

MANDIR=$(PREFIX)/share/man

     8

INSTALL=install -m 644

     9

# Default to Python 3.

    10

#

    11

# Windows ships Python 3 as `python.exe`, which may not be on PATH.  py.exe is.

    12

ifeq ($(OS),Windows_NT)

    13

PYTHON?=py -3

    14

else

    15

PYTHON?=python3

    16

endif

    17

RSTARGS=

    18

    19

export HGENCODING=UTF-8

    20

    21

all: man html

    22

    23

man: $(MAN)

    24

    25

html: $(HTML)

    26

    27

# This logic is duplicated in setup.py:hgbuilddoc()

    28

common.txt $(SOURCES) $(SOURCES:%.txt=%.gendoc.txt): $(GENDOC)

    29

	${PYTHON} gendoc.py "$(basename $@)" > $@.tmp

    30

	mv $@.tmp $@

    31

    32

%: %.txt %.gendoc.txt common.txt

    33

	$(PYTHON) runrst hgmanpage $(RSTARGS) --halt warning \

    34

	  --strip-elements-with-class htmlonly $*.txt $*

    35

    36

%.html: %.txt %.gendoc.txt common.txt

    37

	$(PYTHON) runrst html $(RSTARGS) --halt warning \

    38

	  --link-stylesheet --stylesheet-path style.css $*.txt $*.html

    39

    40

MANIFEST: man html

    41

# tracked files are already in the main MANIFEST

    42

	$(RM) $@

    43

	for i in $(MAN) $(HTML); do \

    44

	  echo "doc/$$i" >> $@ ; \

    45

	done

    46

    47

install: man

    48

	for i in $(MAN) ; do \

    49

	  subdir=`echo $$i | sed -n 's/^.*\.\([0-9]\)$$/man\1/p'` ; \

    50

	  mkdir -p "$(DESTDIR)$(MANDIR)"/$$subdir ; \

    51

	  $(INSTALL) $$i "$(DESTDIR)$(MANDIR)"/$$subdir ; \

    52

	done

    53

    54

clean:

    55

	$(RM) $(MAN) $(HTML) common.txt $(SOURCES) $(SOURCES:%.txt=%.gendoc.txt) MANIFEST