From mboxrd@z Thu Jan 1 00:00:00 1970 From: Dario Faggioli Subject: Re: [PATCH 1/3] docs: Credit1 feature document. Date: Thu, 13 Oct 2016 14:26:50 +0100 Message-ID: <1476365210.3314.33.camel@citrix.com> References: <147635565298.17095.17316867931713209620.stgit@Palanthas> <147635653648.17095.14880201185403654377.stgit@Palanthas> <8bdd7377-ed50-5a50-440f-a47ebecf1966@citrix.com> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="===============4006766630244843372==" Return-path: Received: from mail6.bemta6.messagelabs.com ([193.109.254.103]) by lists.xenproject.org with esmtp (Exim 4.84_2) (envelope-from ) id 1bug2D-0008D3-0k for xen-devel@lists.xenproject.org; Thu, 13 Oct 2016 13:26:57 +0000 In-Reply-To: <8bdd7377-ed50-5a50-440f-a47ebecf1966@citrix.com> List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Errors-To: xen-devel-bounces@lists.xen.org Sender: "Xen-devel" To: Andrew Cooper , xen-devel@lists.xenproject.org Cc: Lars Kurth , Stefano Stabellini , Wei Liu , George Dunlap , Ian Jackson , Jan Beulich List-Id: xen-devel@lists.xenproject.org --===============4006766630244843372== Content-Type: multipart/signed; micalg=pgp-sha256; protocol="application/pgp-signature"; boundary="=-SDC+NXOKWbRpQBjoxIgb" --=-SDC+NXOKWbRpQBjoxIgb Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable On Thu, 2016-10-13 at 12:47 +0100, Andrew Cooper wrote: > On 13/10/16 12:02, Dario Faggioli wrote: > >=20 > > diff --git a/docs/features/credit.pandoc > > b/docs/features/credit.pandoc > > new file mode 100644 > > index 0000000..fed0da2 > > --- /dev/null > > +++ b/docs/features/credit.pandoc >=20 > Simply "Credit" as a top level feature isn't very descriptive.=C2=A0=C2=A0= Can > you > see about working scheduler somewhere into the name? >=20 Yep, I wasn't sure whether or not to do that. Re-thinking things, I agree that'd be better. I'll do. > > @@ -0,0 +1,99 @@ > > +% Credit > > +% Revision 1 > > + > > +\clearpage > > + > > +# Basics > > +---------------- ----------------------------------------------- > > ----- > > +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0Status: e.g. **= Supported** > > + > > +Architecture(s): e.g. x86, arm > > + > > +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0Component: e.g. Hypervisor > > +---------------- ----------------------------------------------- > > ----- >=20 > You should drop the e.g.'s.=C2=A0=C2=A0 > Which I was sure I'd have done... sorry. > In cases like this where it really is just > a software algorithm, I would suggest setting the architecture to > all, > or omitting the line entirely.=C2=A0=C2=A0 > Omitting the line is what I also was considering myself. Again, will do. > > +# Overview > > + > > +Credit (also known as Credit1) is the default virtual CPU (vCPU) > > scheduler > > +of the Xen hypervisor. The job of an hypervisor's scheduler is to > > decide, > > +among all the various vCPUs of the various virtual machines, which > > ones > > +should execute on the host's physical CPUs (pCPUs), at any given > > point in > > +time. >=20 > A lot of this is generic to all schedulers. >=20 Not really. Well, sure some is, but, at the end, this period is pretty much the only one that is present, identical to itself, in all the three documents (and I certainly can see about shortening or removing it, if we don't want that). And in fact, the rest... > I wonder whether it might be better to have a schedulers meta-feature > doc which deals with the common scheduler parts,=20including > interactions > on the Xen command line, xl, etc. >=20 ...may look similar, but they're subtle differences spread around. And the more subtle those differences, the higher the amount of cross- referencing between different documents would be, making it more difficult to read and understand what the situation is for one specific scheduler. xl interface is a good example: sub-commands are very similar, but then the scheduling parameters are different for each scheduler. The way in which you create a cpupool is the same (modulo the name=3D""), but doesn't necessarily have to be, e.g., if we start allowing specifing some of the global parameters of the scheduler on the command line (e.g., "create a Credit cpupool, but with timeslice=3D10"). Not possible right now, but doable, and even convenient (I've already have plans for that :-P). So, FWIW, I would stick with different documents. > > +Once the system is live, for creating a cpupool with Credit as its > > +scheduler, either compile a cpupool configuration file, as > > described > > +in `docs/man/xlcpupool.cfg.pod.5` (and as exemplified in > > +`tools/examples/cpupool`), or use just `xl` directly: >=20 > I should see about ensuring that cross-references work with the > HTML-generated versions of these docs.=C2=A0=C2=A0You might be able to g= et away > with just putting in a plain hyperlink here. >=20 I thought about that, but then ended up following suit from your docs/feature/migration.pandoc. I'll turn this in links if that's what you think is best. Personally, I 's say it makes the _text_ document a bit less readable, but I guess the version we care about is the _HTML_ one? Anyway, I'm basically ok with anything. :-) Thanks and Regards, Dario --=20 <> (Raistlin Majere) ----------------------------------------------------------------- Dario Faggioli, Ph.D, http://about.me/dario.faggioli Senior Software Engineer, Citrix Systems R&D Ltd., Cambridge (UK) --=-SDC+NXOKWbRpQBjoxIgb Content-Type: application/pgp-signature; name="signature.asc" Content-Description: This is a digitally signed message part Content-Transfer-Encoding: 7bit -----BEGIN PGP SIGNATURE----- Version: GnuPG v2 iQIcBAABCAAGBQJX/4uaAAoJEBZCeImluHPuw8cQAM8igUV2mr6jRBRsuNBsYoxe 4pldPRIm6t3GgYed4j5x/jFXduyszjK/MwfKk73bjiqfoxQX1C260Qn7Hxi7/Ioy q9XfD+iQYUzCGOulgr37DZUOzKdYv9vlZN1vnrSvTevH5BqCfYTye0d5HLj+Brk5 qCPFF735gxetYMSfn/xcp1dJTWPvxWmzXTWQqZjJkPsgtFGk9cumd7B6RO4V0/7d 4hvLIREm6yuDYPBs/25xjh2QqVRBcszT9z8QHIOJKMrqR/qFJLJNJncTFzscEOK0 l2tx2wvFc4y9nHvSKg5gzU/yIwH8sTd+GfUnBdqlbUGo7KJlEjMYe6tZ8cCEau3y 1sKWHWFZZynsmOnEvoWuXRfTr6nVqcTMLEOZSGjtMF53T3vz01FNAbLHE9U8M2V8 zADEba8pJtXUVUgsDwxeikP+67ZoN4VgR93DFVlTO2K3JFOtUbxo4xvTZrrh3oIR r0GNnfaF+o6f0b3JjjxXi0TDt0lmbXFAX9HOSRRxB03qNvShRq6B1JuL4CAl6wFm MLOcJCtMzpZMKY+a07PustxRndwlnfgIiQNbYuR8NUD/aBGIZFY1hdGX5j3ujo5i 8pi56/CtlZ4MOLFPrjcNXlBiJpoV2/+ltrUkA8uVGHsNVpuNx0D8ett7Wbwo1rsh L4aIxEuMD/3/zUDILwxs =MMk5 -----END PGP SIGNATURE----- --=-SDC+NXOKWbRpQBjoxIgb-- --===============4006766630244843372== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: base64 Content-Disposition: inline X19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX18KWGVuLWRldmVs IG1haWxpbmcgbGlzdApYZW4tZGV2ZWxAbGlzdHMueGVuLm9yZwpodHRwczovL2xpc3RzLnhlbi5v cmcveGVuLWRldmVsCg== --===============4006766630244843372==--