# HG changeset patch
# User Markus Mützel <markus.muetzel@gmx.de>
# Date 1660203412 -7200
# Node ID e217b44187a207bd576b7a687756ee6006871afc
# Parent  51311efef5dde75525b1dbf8fa22ec4b81240402
doc: Clarify number of processors returned by "nproc" with hyperthreading.

* libinterp/corefcn/nproc.cc (Fnproc): Clarify that the number of processors
returned by this function might be higher than the number of physical cores
(for processors with hyperthreading).

See: https://octave.discourse.group/t/3121/20

diff -r 51311efef5dd -r e217b44187a2 libinterp/corefcn/nproc.cc
--- a/libinterp/corefcn/nproc.cc	Thu Aug 04 18:32:51 2022 +0200
+++ b/libinterp/corefcn/nproc.cc	Thu Aug 11 09:36:52 2022 +0200
@@ -38,7 +38,10 @@
        doc: /* -*- texinfo -*-
 @deftypefn  {} {} nproc ()
 @deftypefnx {} {} nproc (@var{query})
-Return the current number of available processors.
+Return the current number of available (logical) processors.
+
+This returns the number of logical processors.  For processors with
+hyperthreading, this is larger than the number of physical cores.
 
 If called with the optional argument @var{query}, modify how processors
 are counted as follows: